Skip to content

[Gardening] Add missing "clone TSC" step to bootstrap instructions and reformat existing steps #3598

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 1 commit into from
Jul 8, 2021
Merged

[Gardening] Add missing "clone TSC" step to bootstrap instructions and reformat existing steps #3598

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
79 changes: 45 additions & 34 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,40 +129,51 @@ It is used on bare systems to bootstrap the Swift toolchain (including SwiftPM),
The bootstrap script requires having [CMake](https://cmake.org/) and [Ninja](https://ninja-build.org/) installed.
Please refer to the [_Get Started_ guide](https://github.com/apple/swift/blob/main/docs/HowToGuides/GettingStarted.md#installing-dependencies) on the Swift project repository for installation instructions.

1. Clone [llbuild](https://github.com/apple/swift-llbuild) beside the SwiftPM directory.

```bash
$> git clone https://github.com/apple/swift-llbuild llbuild
```

Note: Make sure the directory for llbuild is called "llbuild" and not
"swift-llbuild".

2. Clone [Yams](https://github.com/jpsim/yams) beside the SwiftPM directory.

```bash
$> git clone https://github.com/jpsim/yams
```

3. Clone [swift-driver](https://github.com/apple/swift-driver) beside the SwiftPM directory.

```bash
$> git clone https://github.com/apple/swift-driver
```

4. Clone [swift-argument-parser](https://github.com/apple/swift-argument-parser) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).

For example, if the latest tag is 0.3.1:
```bash
$> git clone https://github.com/apple/swift-argument-parser --branch 0.3.1
```

5. Clone [swift-crypto](https://github.com/apple/swift-crypto) beside the SwiftPM directory and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).

For example, if the latest tag is 1.1.3:
```bash
$> git clone https://github.com/apple/swift-crypto --branch 1.1.3
```
Clone the following repositories beside the SwiftPM directory:

1. [swift-argument-parser] and check out tag with the [latest version](https://github.com/apple/swift-argument-parser/tags).

For example, if the latest tag is 0.4.3:
```sh
$> git clone https://github.com/apple/swift-argument-parser --branch 0.4.3
```

2. [swift-llbuild] as llbuild
```sh
$> git clone https://github.com/apple/swift-llbuild llbuild
```
> Note: Make sure the directory for llbuild is called "llbuild" and not "swift-llbuild".

3. [swift-tools-support-core]
```sh
$> git clone https://github.com/apple/swift-tools-support-core
```

4. [Yams] and checkout tag with the [latest version](https://github.com/jpsim/Yams.git/tags) before 5.0.0.

For example, if the latest tag is 4.0.6:
```sh
$> git clone https://github.com/jpsim/yams --branch 4.0.6
```

5. [swift-driver]
```sh
$> git clone https://github.com/apple/swift-driver
```

6. [swift-crypto] and check out tag with the [latest version](https://github.com/apple/swift-crypto/tags).

For example, if the latest tag is 1.1.6:
```sh
$> git clone https://github.com/apple/swift-crypto --branch 1.1.6
```

[swift-argument-parser]: https://github.com/apple/swift-argument-parser
[swift-crypto]: https://github.com/apple/swift-crypto
[swift-driver]: https://github.com/apple/swift-driver
[swift-llbuild]: https://github.com/apple/swift-llbuild
[swift-tools-support-core]: https://github.com/apple/swift-tools-support-core
[Yams]: https://github.com/jpsim/yams

#### Building

Expand Down