From f0dcc4839b93d642c23f437ea40bd77c2a7eb631 Mon Sep 17 00:00:00 2001 From: Butta Date: Mon, 28 Jun 2021 09:19:23 +0530 Subject: [PATCH] [docs] fix formatting for GettingStarted.md and add needed flag for linux --- docs/HowToGuides/GettingStarted.md | 37 +++++++++++++++--------------- 1 file changed, 19 insertions(+), 18 deletions(-) diff --git a/docs/HowToGuides/GettingStarted.md b/docs/HowToGuides/GettingStarted.md index 8e46384b1d604..eafdec9d1cf07 100644 --- a/docs/HowToGuides/GettingStarted.md +++ b/docs/HowToGuides/GettingStarted.md @@ -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`