Skip to content

Commit 131db61

Browse files
committed
[docs] Move debugging docs into new Development.md
1 parent 9e84e08 commit 131db61

File tree

2 files changed

+24
-21
lines changed

2 files changed

+24
-21
lines changed

Documentation/Development.md

Lines changed: 22 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,29 @@ This document contains notes about development and testing of SourceKit-LSP.
44

55
## Table of Contents
66

7+
* [Debugging](#debugging)
78
* [Writing Tests](#writing-tests)
8-
* [Tibs, the "Test Index Build System"](#tibs)
9+
10+
## Debugging
11+
12+
You can attach LLDB to SourceKit-LSP and set breakpoints to debug. You may want to instruct LLDB to wait for the sourcekit-lsp process to launch and then start your editor, which will typically launch
13+
SourceKit-LSP as soon as you open a Swift file:
14+
15+
```sh
16+
$ lldb -w -n sourcekit-lsp
17+
```
18+
19+
If you are using the Xcode project, go to Debug, Attach to Process by PID or Name.
20+
21+
### Print SourceKit Logs
22+
23+
You can configure SourceKit-LSP to print log information from SourceKit to stderr by setting the following environment variable:
24+
25+
```sh
26+
SOURCEKIT_LOGGING="N"
27+
```
28+
29+
Where "N" configures the log verbosity and is one of the following numbers: 0 (error), 1 (warning), 2 (info), or 3 (debug).
930

1031
## Writing Tests
1132

README.md

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -51,27 +51,9 @@ $ swift package generate-xcodeproj --xcconfig-overrides overrides.xcconfig
5151
$ open SourceKitLSP.xcodeproj
5252
```
5353

54-
## Debugging
54+
## Development
5555

56-
You can attach LLDB to SourceKit-LSP and set breakpoints to debug. You may want to instruct LLDB to wait for the sourcekit-lsp process to launch and then start your editor, which will typically launch
57-
SourceKit-LSP as soon as you open a Swift file:
58-
59-
60-
```sh
61-
$ lldb -w -n sourcekit-lsp
62-
```
63-
64-
If you are using the Xcode project, go to Debug, Attach to Process by PID or Name.
65-
66-
### Print SourceKit Logs
67-
68-
You can configure SourceKit-LSP to print log information from SourceKit to stderr by setting the following environment variable:
69-
70-
```sh
71-
SOURCEKIT_LOGGING="N"
72-
```
73-
74-
Where "N" configures the log verbosity and is one of the following numbers: 0 (error), 1 (warning), 2 (info), or 3 (debug).
56+
For more information about developing SourceKit-LSP, see [Development](Documentation/Development.md).
7557

7658
## Toolchains
7759

0 commit comments

Comments
 (0)