Skip to content

Commit 5af8a8b

Browse files
committed
Add comment in Development.md that updating PATH is important
I’ve spend an hour trying to figure out why the test suite didn’t pass, because I was trying to be clever and not modify my `PATH` to have `<path_to_swift_toolchain>/usr/bin` as the first entry. So: Add a comment, telling you to not try and be clever.
1 parent 3879b12 commit 5af8a8b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

Documentation/Development.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ $ swift package update
4444
$ swift build -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift/Block
4545
```
4646

47+
Setting `PATH` as described above is important even if `<path_to_swift_toolchain>/usr/bin` is already in your `PATH` because `/usr/bin` must be the **first** path to search.
48+
4749
After building, the server will be located at `.build/debug/sourcekit-lsp`, or a similar path, if you passed any custom options to `swift build`. Editors will generally need to be provided with this path in order to run the newly built server - see [Editors](../Editors) for more information about configuration.
4850

4951
SourceKit-LSP is designed to build against the latest SwiftPM, so if you run into any issue make sure you have the most up-to-date dependencies by running `swift package update`.

0 commit comments

Comments
 (0)