Skip to content

[docs] fix formatting for GettingStarted.md and add needed flag for linux #61511

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
Oct 10, 2022
Merged

[docs] fix formatting for GettingStarted.md and add needed flag for linux #61511

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
37 changes: 19 additions & 18 deletions docs/HowToGuides/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,25 +240,26 @@ 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:
- macOS:
- Via Ninja:
```sh
utils/build-script --skip-build-benchmarks \
--skip-ios --skip-watchos --skip-tvos --swift-darwin-supported-archs "$(uname -m)" \
--sccache --release-debuginfo --swift-disable-dead-stripping --test
```
- Via Xcode:
```sh
utils/build-script --skip-build-benchmarks \
--skip-ios --skip-watchos --skip-tvos --swift-darwin-supported-archs "$(uname -m)" \
--sccache --release-debuginfo --swift-disable-dead-stripping \
--xcode
```
**Note:** Building `--xcode` together with `--test` is a common source of issues. So to run
tests is recommended to use `ninja` because is normally more stable.
- Linux (uses Ninja):
```sh
utils/build-script --skip-build-benchmarks \
--skip-ios --skip-watchos --skip-tvos --swift-darwin-supported-archs "$(uname -m)" \
--sccache --release-debuginfo --swift-disable-dead-stripping --test
```
- Via Xcode:
```sh
utils/build-script --skip-build-benchmarks \
--skip-ios --skip-watchos --skip-tvos --swift-darwin-supported-archs "$(uname -m)" \
--sccache --release-debuginfo --swift-disable-dead-stripping \
--xcode
```
**Note:** Building `--xcode` together with `--test` is a common source of issues. So to run
tests is recommended to use `ninja` because is normally more stable.
Linux (uses Ninja):
```sh
utils/build-script --release-debuginfo --test --skip-early-swift-driver
utils/build-script --release-debuginfo --test --skip-early-swift-driver \
--skip-early-swiftsyntax
```
This will create a directory
`swift-project/build/Ninja-RelWithDebInfoAssert`
Expand Down