Skip to content

Modify Getting Started to recommend the 5.10 toolchain temporarily. #76

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 2 commits into from
Oct 23, 2023
Merged

Modify Getting Started to recommend the 5.10 toolchain temporarily. #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37c353f
Modify Getting Started to recommend the 5.10 toolchain temporarily.
grynspan Oct 23, 2023
16f8d1e
Update CONTRIBUTING.md too.
grynspan Oct 23, 2023
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
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,23 @@ and install a toolchain.

#### Installing a toolchain

<!--
- 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))
-->

<!--
1. Download a toolchain. A recent **development snapshot** toolchain is required
to build the testing library. Visit
[swift.org](https://www.swift.org/download/#trunk-development-main) and
download the most recent toolchain from the section titled
**Snapshots — Trunk Development (main)**.
-->

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.
Expand Down
17 changes: 14 additions & 3 deletions Sources/Testing/Testing.docc/TemporaryGettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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))
}

<!--A recent **development snapshot** toolchain is required to use the testing
library. Visit [swift.org](https://www.swift.org/download/#trunk-development-main)
to download and install a toolchain from the section titled
**Snapshots — Trunk Development (main)**.
**Snapshots — Trunk Development (main)**.-->

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.
Expand Down Expand Up @@ -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&mdash;it will
be presented with a name such as "Swift Development Toolchain 2023-01-01 (a)".
<!--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

Expand Down