Skip to content

Commit eee197c

Browse files
[docs] GettingStarted.md: Do not suggest to run tests when building toolchain
* Running the entire test suite is unnecessarily burdensome for newcomers, given the already considerable build times. * Test failures are not a beginner-friendly indication of an out-of-sync checkout, nor is such an indication generally worth the expenses. * We do not want a known issue to block anyone’s workflow.
1 parent 5eb942c commit eee197c

File tree

1 file changed

+4
-13
lines changed

1 file changed

+4
-13
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ toolchain as a one-off, there are a couple of differences:
1515
- [Cloning the project](#cloning-the-project)
1616
- [Troubleshooting cloning issues](#troubleshooting-cloning-issues)
1717
- [Installing dependencies](#installing-dependencies)
18-
- [macOS](#macOS)
18+
- [macOS](#macos)
1919
- [Linux](#linux)
2020
- [Building the project for the first time](#building-the-project-for-the-first-time)
2121
- [Spot check dependencies](#spot-check-dependencies)
@@ -245,7 +245,7 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
245245
```sh
246246
utils/build-script --skip-build-benchmarks \
247247
--skip-ios --skip-watchos --skip-tvos --swift-darwin-supported-archs "$(uname -m)" \
248-
--sccache --release-debuginfo --swift-disable-dead-stripping --test
248+
--sccache --release-debuginfo --swift-disable-dead-stripping
249249
```
250250
- Via Xcode:
251251
```sh
@@ -254,25 +254,16 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
254254
--sccache --release-debuginfo --swift-disable-dead-stripping \
255255
--xcode
256256
```
257-
**Note:** Building `--xcode` together with `--test` is a common source of issues. So to run
258-
tests is recommended to use `ninja` because is normally more stable.
259257
- Linux (uses Ninja):
260258
```sh
261-
utils/build-script --release-debuginfo --test --skip-early-swift-driver \
259+
utils/build-script --release-debuginfo --skip-early-swift-driver \
262260
--skip-early-swiftsyntax
263261
```
264262
This will create a directory
265263
`swift-project/build/Ninja-RelWithDebInfoAssert`
266264
(with `Xcode` instead of `Ninja` if you used `--xcode`)
267265
containing the Swift compiler and standard library and clang/LLVM build artifacts.
268-
- If the build succeeds: Once the build is complete, the tests will run.
269-
- If the tests are passing: Great! We can go to the next step.
270-
- If some tests are failing:
271-
- Consider [filing a bug report](https://swift.org/contributing/#reporting-bugs).
272-
- Note down which tests are failing as a baseline. This baseline will be
273-
handy later when you run the tests after making a change.
274-
- If the build fails:
275-
See [Troubleshooting build issues](#troubleshooting-build-issues).
266+
If the build fails, see [Troubleshooting build issues](#troubleshooting-build-issues).
276267

277268
If you would like to additionally build the Swift corelibs,
278269
ie swift-corelibs-libdispatch, swift-corelibs-foundation, and swift-corelibs-xctest,

0 commit comments

Comments
 (0)