Skip to content

Commit 7b1f6a8

Browse files
authored
Merge pull request #1143 from incertum/update-static-sdk-installation
update[static-sdk]: expand installation section
2 parents d3831d4 + b8a367c commit 7b1f6a8

File tree

1 file changed

+62
-27
lines changed

1 file changed

+62
-27
lines changed

documentation/articles/static-linux-getting-started.md

Lines changed: 62 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -108,55 +108,90 @@ and can be installed by simply copying.
108108

109109
### Installing the SDK
110110

111-
Before you start, it's important to note:
111+
#### (1) Prerequisites
112112

113-
* You will need to [install an Open Source toolchain from
114-
swift.org](/install/).
113+
Before starting, please note the following requirements:
115114

116-
* You cannot use the toolchain provided with Xcode to build programs
117-
using the SDK.
115+
* You need to install an open-source [Swift toolchain](/install/) from
116+
swift.org.
118117

119-
* If you are using macOS, you will also need to ensure that you use
120-
the Swift compiler from this toolchain by [following the
121-
instructions
122-
here](/install/macos/package_installer/).
118+
* If you are using macOS, note that you cannot use the toolchain
119+
provided with Xcode to build programs using the SDK. Instead, you
120+
must use the Swift compiler from the open-source toolchain (see
121+
above).
123122

124-
* The toolchain must match the version of the Static Linux SDK that
125-
you install. The Static Linux SDK includes the corresponding Swift
126-
version in its filename to help identify the correct version of the
127-
SDK.
123+
#### (2) Pre-Installation Notes
128124

129-
* When installing Swift SDKs from remote URLs, you have to pass a
130-
`--checksum` option with the corresponding checksum provided by the
131-
author of the Swift SDK.
125+
Please be aware of:
132126

133-
Once that is out of the way, actually installing the Static Linux SDK
134-
is easy; at a prompt, enter
127+
* Version compatibility: The Swift toolchain must match the version of
128+
the Static Linux SDK that you install.
129+
130+
* Clean installation: If you previously installed an SDK for a
131+
different Swift toolchain version, remove the old one before
132+
installing the new one (see management commands below).
133+
134+
* Checksum verification: When installing Swift SDKs from remote URLs,
135+
you must pass a `--checksum` option with the corresponding checksum
136+
provided by the SDK author.
137+
138+
* Command pattern: The installation follows the pattern described in
139+
the next sections.
140+
141+
#### (3) Download and Install the Static Linux SDK
142+
143+
To obtain the Static Linux SDK:
144+
145+
* Visit the swift.org [installation
146+
page](https://www.swift.org/install) for complete Static Linux SDK
147+
installation instructions, where you can download directly or click
148+
"Copy install command".
149+
150+
* For previous releases, navigate to "Previous Releases" on the
151+
installation page.
152+
153+
154+
#### (4) Installation Commands Pattern
155+
156+
The basic installation command follows this pattern:
135157

136158
```console
137159
$ swift sdk install <URL-or-filename-here> [--checksum <checksum-for-archive-URL>]
138160
```
139161

140-
giving the URL (and a corresponding checksum) or filename at which the SDK can be found.
162+
You can provide either a URL (with corresponding checksum) or a local
163+
filename where the SDK can be found.
164+
165+
<!--
166+
{% assign platform = site.data.builds.swift_releases.last.platforms | where: 'name', 'Static SDK'| first %}
167+
{% assign tag = site.data.builds.swift_releases.last.tag %}
168+
{% assign tag_downcase = site.data.builds.swift_releases.last.tag | downcase %}
169+
{% assign base_url = "https://download.swift.org/" | append: tag_downcase | append: "/static-sdk/" | append: tag | append: "/" | append: tag %}
170+
{% assign command = "swift sdk install " | append: base_url | append: "_static-linux-0.0.1.artifactbundle.tar.gz --checksum " | append: platform.checksum %}
141171
142-
For instance, assuming you have installed the
143-
`swift-6.0-DEVELOPMENT-SNAPSHOT-2024-07-02-a` toolchain, you would
144-
need to enter
172+
{% comment %} Generate branch information - ONLY major.minor {% endcomment %}
173+
-->
174+
175+
For example, if you have installed the {{ tag }} toolchain, you would enter:
145176

146177
```console
147-
$ swift sdk install https://download.swift.org/swift-6.0-branch/static-sdk/swift-6.0-DEVELOPMENT-SNAPSHOT-2024-07-02-a/swift-6.0-DEVELOPMENT-SNAPSHOT-2024-07-02-a_static-linux-0.0.1.artifactbundle.tar.gz --checksum 42a361e1a240e97e4bb3a388f2f947409011dcd3d3f20b396c28999e9736df36
178+
$ {{ command }}
148179
```
149180

150-
to install the corresponding Static Linux SDK.
181+
This will download and install the corresponding Static Linux SDK on
182+
your system.
183+
184+
#### (5) Managing Installed SDKs
185+
186+
After installation, you can manage your SDKs using these commands:
151187

152-
Swift will download and install the SDK on your system. You can get a
153-
list of installed SDKs with
188+
List all installed SDKs:
154189

155190
```console
156191
$ swift sdk list
157192
```
158193

159-
and it's also possible to remove them using
194+
Remove an SDK:
160195

161196
```console
162197
$ swift sdk remove <name-of-SDK>

0 commit comments

Comments
 (0)