List dependencies to build SourceKit-LSP in the Linux section #403
Conversation
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.
They were previously only listed in the Docker section, but they apply to general Linux equally.
| ```sh | ||
| $ export PATH="<path_to_swift_toolchain>/usr/bin:${PATH}" | ||
| $ swift package update | ||
| $ swift build -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift/Block | ||
| ``` | ||
|
|
||
| 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. |
There was a problem hiding this comment.
because
/usr/binmust be the first path to search.
Why would it need to be first? Obviously if you have more than one toolchain on your path you need the right one to come before the wrong one, but that's just normal PATH behaviour.
There was a problem hiding this comment.
The problem is that in the docker container, we have the following PATH:
/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
sourcekit-lsp finds libsourcekitdInProc and libIndexStore relative to /usr/sbin in /usr/sbin/../lib/ (aka. /usr/lib). Thus /usr/sbin is not discarded and it becomes the default toolchain. But it doesn’t contain the swift (or clang) executable, causing all sorts of later failures. If /usr/bin is before /usr/sbin in PATH, we don’t hit this issue.
There was a problem hiding this comment.
Okay, the note is fine for now, but this seems like something we should fix. We could recognize when one toolchain is a strict superset of another one (sbin and bin have the same libraries but only bin has the executables).
|
@swift-ci please test |
They were previously only listed in the Docker section, but they apply to general Linux equally.
Also add a comment that modifying your
PATHis really necessary and that you shouldn’t try to be clever and skip that step.Resolves rdar://77853086 [SR-14614]