Skip to content

Commit 931342c

Browse files
authored
Merge pull request #70374 from finagolfin/nux
[docs] GettingStarted: Update the linux instructions to use a prebuilt Swift compiler
2 parents 017ed74 + 22e1ed3 commit 931342c

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,11 @@ toolchain as a one-off, there are a couple of differences:
164164
* [CentOS 7](https://github.com/apple/swift-docker/blob/main/swift-ci/master/centos/7/Dockerfile)
165165
* [Amazon Linux 2](https://github.com/apple/swift-docker/blob/main/swift-ci/master/amazon-linux/2/Dockerfile)
166166
167+
Note that [a prebuilt Swift release toolchain](https://www.swift.org/download/)
168+
is installed and added to the `PATH` in all these Docker containers: it is
169+
recommended that you do the same, in order to build the portions of the Swift
170+
compiler written in Swift.
171+
167172
2. To install [Sccache][] (optional):
168173
* If you're not building within a Docker container:
169174
```sh
@@ -258,21 +263,17 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
258263
```
259264
- Linux:
260265
```sh
261-
utils/build-script --release-debuginfo --skip-early-swift-driver \
262-
--skip-early-swiftsyntax
266+
utils/build-script --release-debuginfo
263267
```
264268
If you installed and want to use Sccache, include the `--sccache` option in
265269
the invocation as well.
266270
<!-- FIXME: Without this "hard" line break, the note doesn’t get properly spaced from the bullet -->
267271
<br />
268272
269273
> **Note**
270-
> If you are planning to work on the compiler, but not the parts that are
274+
> If you are planning to work on the compiler on macOS, but not the parts that are
271275
> written in Swift, pass `--bootstrapping=hosttools` to speed up local
272-
> development. Note that on Linux — unlike macOS, where the toolchain already
273-
> comes with Xcode — this option additionally requires
274-
> [a recent Swift toolchain](https://www.swift.org/download/) to be
275-
> installed.
276+
> development.
276277
277278
This will create a directory `swift-project/build/Ninja-RelWithDebInfoAssert`
278279
containing the Swift compiler and standard library and clang/LLVM build artifacts.
@@ -284,9 +285,9 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
284285
> Consider [`--debug-swift` to build a debug variant of the compiler](#debugging-issues) and have
285286
> the swift targets (including `swift-frontend`) built in debug mode.
286287
287-
If you would like to additionally build the Swift corelibs,
288+
On Linux, if you would like to additionally build the Swift corelibs,
288289
ie swift-corelibs-libdispatch, swift-corelibs-foundation, and swift-corelibs-xctest,
289-
on Linux, add the `--xctest` flag to `build-script`.
290+
add the `--xctest` flag to `build-script`.
290291
291292
In the following sections, for simplicity, we will assume that you are using a
292293
`Ninja-RelWithDebInfoAssert` build on macOS, unless explicitly mentioned otherwise.

0 commit comments

Comments
 (0)