diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 064899699..cf2d665da 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -59,11 +59,23 @@ and install a toolchain. #### Installing a toolchain + + + + +1. A recent **Swift 5.10 development snapshot** toolchain is required to build + the testing library. Visit [swift.org](https://www.swift.org/download/#swift-510-development) + to download and install a toolchain from the section titled + **Snapshots — Swift 5.10 Development**. Be aware that development snapshot toolchains are not intended for day-to-day development and may contain defects that affect the programs built with them. diff --git a/Sources/Testing/Testing.docc/TemporaryGettingStarted.md b/Sources/Testing/Testing.docc/TemporaryGettingStarted.md index 2302debe5..84b55c3af 100644 --- a/Sources/Testing/Testing.docc/TemporaryGettingStarted.md +++ b/Sources/Testing/Testing.docc/TemporaryGettingStarted.md @@ -30,10 +30,20 @@ To learn how to contribute to the testing library itself, see ### Downloading a development toolchain -A recent **development snapshot** toolchain is required to use the testing +A recent **Swift 5.10 development snapshot** toolchain is required to use the +testing library. Visit [swift.org](https://www.swift.org/download/#swift-510-development) +to download and install a toolchain from the section titled +**Snapshots — Swift 5.10 Development**. + +@Comment { + - Bug: A compiler bug in the Swift main branch is temporarily preventing its + use with the testing library. ([swift-#69096](https://github.com/apple/swift/issues/69096)) +} + + Be aware that development snapshot toolchains are not intended for day-to-day development and may contain defects that affect the programs built with them. @@ -109,7 +119,8 @@ export TOOLCHAINS=swift In Xcode, open the **Xcode** menu, then the Toolchains submenu, and select the development toolchain from the list of toolchains presented to you—it will -be presented with a name such as "Swift Development Toolchain 2023-01-01 (a)". + +be presented with a name such as "Swift 5.10 Development Snapshot 2023-01-01 (a)". ### Running tests