Skip to content

Commit e47444f

Browse files
committed
[docs] GettingStarted.md: Warn about bootstrapping bug on Macs with arm64 chips
Also, suggest opting out of bootstrapping when appropriate.
1 parent fdababa commit e47444f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

docs/HowToGuides/GettingStarted.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -238,11 +238,20 @@ Phew, that's a lot to digest! Now let's proceed to the actual build itself!
238238
--skip-ios --skip-watchos --skip-tvos --swift-darwin-supported-archs "$(uname -m)" \
239239
--sccache --release-debuginfo --swift-disable-dead-stripping
240240
```
241+
> **Warning**
242+
> On Macs with Apple silicon (arm64), pass `--bootstrapping=off`.
243+
> (https://github.com/apple/swift/issues/62017)
244+
241245
- Linux:
242246
```sh
243247
utils/build-script --release-debuginfo --skip-early-swift-driver \
244248
--skip-early-swiftsyntax
245249
```
250+
251+
> **Note**
252+
> If you aren't planning to edit the parts of the compiler that are written
253+
> in Swift, pass `--bootstrapping=off` to speed up local development.
254+
246255
This will create a directory `swift-project/build/Ninja-RelWithDebInfoAssert`
247256
containing the Swift compiler and standard library and clang/LLVM build artifacts.
248257
If the build fails, see [Troubleshooting build issues](#troubleshooting-build-issues).

0 commit comments

Comments
 (0)