Skip to content

Commit d97b005

Browse files
authored
Merge pull request #2123 from MahdiBM/patch-2
Fix logging docs for on-Apple platforms
2 parents b921e94 + 227ab8f commit d97b005

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ To adjust the toolchain that should be used by SourceKit-LSP (eg. because you wa
9090
9191
## Logging
9292
93-
SourceKit-LSP has extensive logging to the system log on macOS and to `/var/logs/sourcekit-lsp` or stderr on other platforms.
93+
SourceKit-LSP has extensive logging to the system log on macOS and to `~/.sourcekit-lsp/logs/` or stderr on other platforms.
9494
9595
To show the logs on macOS, run
9696
```sh
@@ -100,6 +100,10 @@ Or to stream the logs as they are produced:
100100
```
101101
log stream --predicate 'subsystem CONTAINS "org.swift.sourcekit-lsp"' --level debug
102102
```
103+
On non-Apple platforms, you can use common commands like `tail` to read the logs or stream them as they are produced:
104+
```
105+
tail -F ~/.sourcekit-lsp/logs/*
106+
```
103107
104108
SourceKit-LSP masks data that may contain private information such as source file names and contents by default. To enable logging of this information, follow the instructions in [Diagnose Bundle.md](Documentation/Diagnose%20Bundle.md).
105109

0 commit comments

Comments
 (0)