Skip to content

Commit c673023

Browse files
committed
[docs] Add basic build-script command for Linux and corelibs flag
1 parent d3d87e8 commit c673023

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,7 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
246246
[using both Ninja and Xcode](#using-both-ninja-and-xcode).
247247
3. Build the toolchain with optimizations, debuginfo, and assertions and run
248248
the tests.
249+
macOS:
249250
- Via Ninja:
250251
```sh
251252
utils/build-script --skip-build-benchmarks \
@@ -259,10 +260,14 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
259260
--sccache --release-debuginfo --swift-disable-dead-stripping --test \
260261
--xcode
261262
```
263+
Linux (uses Ninja):
264+
```sh
265+
utils/build-script --release-debuginfo --test --skip-early-swift-driver
266+
```
262267
This will create a directory
263268
`swift-project/build/Ninja-RelWithDebInfoAssert`
264269
(with `Xcode` instead of `Ninja` if you used `--xcode`)
265-
containing the build artifacts.
270+
containing the Swift compiler and standard library and clang/LLVM build artifacts.
266271
- If the build succeeds: Once the build is complete, the tests will run.
267272
- If the tests are passing: Great! We can go to the next step.
268273
- If some tests are failing:
@@ -272,6 +277,10 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
272277
- If the build fails:
273278
See [Troubleshooting build issues](#troubleshooting-build-issues).
274279

280+
If you would like to additionally build the Swift corelibs,
281+
ie swift-corelibs-libdispatch, swift-corelibs-foundation, and swift-corelibs-xctest,
282+
on Linux, add the `--xctest` flag to `build-script`.
283+
275284
In the following sections, for simplicity, we will assume that you are using a
276285
`Ninja-RelWithDebInfoAssert` build on macOS running on an Intel-based Mac,
277286
unless explicitly mentioned otherwise. You will need to slightly tweak the paths

0 commit comments

Comments
 (0)