Skip to content

[docs] Add basic build-script command for Linux and corelibs flag #38067

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 24, 2021
Merged

[docs] Add basic build-script command for Linux and corelibs flag #38067

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/HowToGuides/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -246,6 +246,7 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
[using both Ninja and Xcode](#using-both-ninja-and-xcode).
3. Build the toolchain with optimizations, debuginfo, and assertions and run
the tests.
macOS:
- Via Ninja:
```sh
utils/build-script --skip-build-benchmarks \
Expand All @@ -259,10 +260,14 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
--sccache --release-debuginfo --swift-disable-dead-stripping --test \
--xcode
```
Linux (uses Ninja):
```sh
utils/build-script --release-debuginfo --test --skip-early-swift-driver
```
This will create a directory
`swift-project/build/Ninja-RelWithDebInfoAssert`
(with `Xcode` instead of `Ninja` if you used `--xcode`)
containing the build artifacts.
containing the Swift compiler and standard library and clang/LLVM build artifacts.
- If the build succeeds: Once the build is complete, the tests will run.
- If the tests are passing: Great! We can go to the next step.
- If some tests are failing:
Expand All @@ -272,6 +277,10 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
- If the build fails:
See [Troubleshooting build issues](#troubleshooting-build-issues).

If you would like to additionally build the Swift corelibs,
ie swift-corelibs-libdispatch, swift-corelibs-foundation, and swift-corelibs-xctest,
on Linux, add the `--xctest` flag to `build-script`.

In the following sections, for simplicity, we will assume that you are using a
`Ninja-RelWithDebInfoAssert` build on macOS running on an Intel-based Mac,
unless explicitly mentioned otherwise. You will need to slightly tweak the paths
Expand Down