Skip to content

[docs] GettingStarted: Add a warning about spaces in the absolute path #66456

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
Jun 13, 2023
Merged

[docs] GettingStarted: Add a warning about spaces in the absolute path #66456

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
8 changes: 5 additions & 3 deletions docs/HowToGuides/GettingStarted.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,11 @@ toolchain as a one-off, there are a couple of differences:
mkdir swift-project
cd swift-project
```

> **Warning**
> Make sure the absolute path to your `swift-project` directory **does not** contain spaces,
since that might cause issues during the build step.

2. Clone the sources:
- Via SSH (recommended):
If you plan on contributing regularly, cloning over SSH provides a better
Expand Down Expand Up @@ -121,9 +126,6 @@ toolchain as a one-off, there are a couple of differences:

- If `update-checkout` failed, double-check that the absolute path to your
working directory does not have non-ASCII characters.
- If `update-checkout` failed and the absolute path to your working directory
had spaces in it, please [file a bug report][Swift Issues] and change the path
to work around it.
- Before running `update-checkout`, double-check that `swift` is the only
repository inside the `swift-project` directory. Otherwise,
`update-checkout` may not clone the necessary dependencies.
Expand Down