Skip to content

Commit 4e576e6

Browse files
committed
Update readme.
1 parent 36145d0 commit 4e576e6

1 file changed

Lines changed: 6 additions & 4 deletions

File tree

Extension/readme.developer.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,9 @@ your normal VS Code environment.
102102
103103
## Capturing sanitizer diagnostics from the language server
104104

105-
When you run a sanitizer build of the language server (a `-tsan`/`-asan`/`-ubsan` CMake preset that
106-
enables ThreadSanitizer, AddressSanitizer, or UndefinedBehaviorSanitizer), the sanitizer prints its
105+
When you run a sanitizer build of the language server (a `-tsan` or `-asan-ubsan` CMake preset --
106+
ThreadSanitizer, or AddressSanitizer + UndefinedBehaviorSanitizer combined; on Windows use
107+
`windows-x64-asan`, ASan only), the sanitizer prints its
107108
reports to `stderr`. Because the extension talks to the language server over `stdio`, those reports are
108109
easy to miss, and the exit-time backtrace you see in a crash log only shows the sanitizer shutting
109110
down -- not the actual report.
@@ -118,8 +119,9 @@ routes each sanitizer's `log_path` into that directory, so every process -- `cpp
118119
```bash
119120
# macOS/Linux
120121
export CPPTOOLS_SANITIZER_LOG_DIR=/tmp/cpptools-san
121-
# ...launch VS Code with a sanitizer build of cpptools, reproduce the issue, then:
122-
cat /tmp/cpptools-san/tsan.*
122+
# ...launch VS Code with a sanitizer build of cpptools, reproduce the issue, then read the logs.
123+
# A -tsan build writes tsan.<pid>; a combined -asan-ubsan build writes both asan.<pid> and ubsan.<pid>.
124+
cat /tmp/cpptools-san/*
123125
```
124126

125127
The **Run Extension (capture sanitizer logs)** configuration in `.vscode/launch.json` sets this

0 commit comments

Comments
 (0)