Skip to content

Commit 09da6a4

Browse files
authored
Merge pull request #403 from ahoppen/pr/update-dev-readme
List dependencies to build SourceKit-LSP in the Linux section
2 parents 1e62953 + 31cff08 commit 09da6a4

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

Documentation/Development.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,25 +38,25 @@ $ swift build
3838

3939
### Linux
4040

41+
Install the following dependencies of SourceKit-LSP:
42+
43+
* libsqlite3-dev, libncurses5-dev, python, ninja-build
44+
4145
```sh
4246
$ export PATH="<path_to_swift_toolchain>/usr/bin:${PATH}"
4347
$ swift package update
4448
$ swift build -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift -Xcxx -I<path_to_swift_toolchain>/usr/lib/swift/Block
4549
```
4650

51+
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.
52+
4753
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.
4854

4955
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`.
5056

5157
### Docker
5258

53-
SourceKit-LSP should run out of the box using the [Swift official Docker images](https://swift.org/download/#docker). However, developers who wish to build `sourcekit-lsp` from source and to run its test suite will require additional packages to be installed.
54-
55-
* libsqlite3-dev, libncurses5-dev, python, ninja-build
56-
57-
These can be added to a custom Dockerfile that uses a Swift Docker tag for its base image.
58-
59-
Note that you still need to follow the steps listed in the *Linux* section. In the official docker images, the toolchain is located at `/`.
59+
SourceKit-LSP should run out of the box using the [Swift official Docker images](https://swift.org/download/#docker). To build `sourcekit-lsp` from source and run its test suite, follow the steps in the *Linux* section. In the official docker images, the toolchain is located at `/`.
6060

6161
If you are seeing slow compile times, you will most likely need to increase the memory available to the Docker container.
6262

0 commit comments

Comments
 (0)