Skip to content

Update guide to mention correct subdirectory #35556

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
Jan 28, 2021
Merged

Update guide to mention correct subdirectory #35556

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
6 changes: 4 additions & 2 deletions docs/HowToGuides/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,15 +68,17 @@ toolchain as a one-off, there are a couple of differences:
If you plan on contributing regularly, cloning over SSH provides a better
experience. After you've [uploaded your SSH keys to GitHub][]:
```sh
git clone [email protected]:apple/swift.git .
git clone [email protected]:apple/swift.git swift
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dot may be superfluous but it's not incorrect. I would leave it in.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The dot is what makes it incorrect. Unless we change to the swift directory first.

cd swift
utils/update-checkout --clone-with-ssh
```
- Via HTTPS:
If you want to check out the sources as read-only,
or are not familiar with setting up SSH,
you can use HTTPS instead:
```sh
git clone https://github.com/apple/swift.git .
git clone https://github.com/apple/swift.git swift
cd swift
utils/update-checkout --clone
```
**Note:** If you've already forked the project on GitHub at this stage,
Expand Down