Skip to content

Commit 0c4bd83

Browse files
committed
Add a note to the README, that one should create a swift-source directory before using update-checkout to ensure that there are no collisions between update-checkout/swift repositories and other repos that the user may have checked out.
Thanks to ssen for the suggestion!
1 parent cf0fc1a commit 0c4bd83

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,19 +72,27 @@ compiler for C++14 support and create a symlink:
7272

7373
### Getting Sources for Swift and Related Projects
7474

75+
First create a directory for all of the swift sources:
76+
77+
mkdir swift-source
78+
cd swift-source
79+
80+
**Note:** This is important since update-checkout (see below) checks out
81+
repositories next to the swift source directory. This means that if one clones
82+
swift and has other unrelated repositories, update-checkout may not clone those
83+
repositories and will update them instead.
84+
7585
**Via HTTPS** For those checking out sources as read-only, HTTPS works best:
7686

7787
git clone https://github.com/apple/swift.git
78-
cd swift
79-
./utils/update-checkout --clone
88+
./swift/utils/update-checkout --clone
8089

8190
**Via SSH** For those who plan on regularly making direct commits,
8291
cloning over SSH may provide a better experience (which requires
8392
uploading SSH keys to GitHub):
8493

8594
git clone [email protected]:apple/swift.git
86-
cd swift
87-
./utils/update-checkout --clone-with-ssh
95+
./swift/utils/update-checkout --clone-with-ssh
8896

8997
#### CMake
9098
[CMake](http://cmake.org) is the core infrastructure used to configure builds of

0 commit comments

Comments
 (0)