Skip to content

Commit 6a4da69

Browse files
committed
[readme] Describe where toolchains are usually found on macOS/linux
There isn't much to say on Linux, since it's a tarball that the user generally extracted themselves, but on macOS it's not obvious where the toolchains would be located after installing.
1 parent 193ccb1 commit 6a4da69

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,9 +77,15 @@ Use the `swift-DEVELOPMENT-SNAPSHOT-2018-12-07-a` toolchain snapshot from https:
7777

7878
### Selecting the Toolchain
7979

80-
After installing the toolchain, SourceKit-LSP needs to know how to find it. Your editor may have a way to do this directly via a configuration setting, or it may allow you to override the process environment variables used when launching `sourcekit-lsp`. See [Editors](Editors) for more information.
80+
After installing the toolchain, SourceKit-LSP needs to know the path to the toolchain.
8181

82-
The simplest way to configure the toolchain is to set the following environment variable to the absolute path of the toolchain.
82+
* On macOS, the toolchain is installed in `/Library/Developer/Toolchains/` with an `.xctoolchain` extension. The most recently installed toolchain is symlinked as `/Library/Developer/Toolchains/swift-latest.xctoolchain`. If you opted to install for the current user only in the installer, the same paths will be under the home directory, e.g. `~/Library/Developer/Toolchains/`.
83+
84+
* On Linux, the toolchain is wherever the snapshot's `.tar.gz` file was extracted.
85+
86+
Your editor may have a way to configure the toolchain path directly via a configuration setting, or it may allow you to override the process environment variables used when launching `sourcekit-lsp`. See [Editors](Editors) for more information.
87+
88+
Otherwise, the simplest way to configure the toolchain is to set the following environment variable to the absolute path of the toolchain.
8389

8490
```sh
8591
SOURCEKIT_TOOLCHAIN_PATH=<toolchain>

0 commit comments

Comments
 (0)