Skip to content

Commit 2366c08

Browse files
davidmrdavidCaseyCarterStephanTLavavej
authored
Clarify ASan test running instructions (#5240)
Co-authored-by: Casey Carter <[email protected]> Co-authored-by: Stephan T. Lavavej <[email protected]>
1 parent 27f936a commit 2366c08

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -412,7 +412,8 @@ set PATH=C:\STL\out\x64\out\bin\amd64;%PATH%
412412
## Running Tests With Address Sanitizer (ASan)
413413

414414
You don't need any extra steps to run with test code and the code in STL headers instrumented with [ASan][].
415-
The test matrices include both ASan and non-ASan configurations.
415+
The test matrices include both ASan and non-ASan configurations if you don't pass `-Dtags=ASAN` or `-Dnotags=ASAN`
416+
to exclude one or the other.
416417

417418
However, to instrument the separately-compiled code (the DLL, the satellites, the [Import Library][] - everything that's
418419
in `/stl/src`), you need to build the STL with ASan. Change the build steps to add `-DSTL_ASAN_BUILD=ON`:
@@ -425,6 +426,8 @@ cmake --build --preset x64
425426
ASan-instrumented STL binaries require that the executable be instrumented as well, so you'll have to skip the non-ASan
426427
configurations by passing `-Dtags=ASAN` to `stl-lit.py`:
427428

429+
(This example assumes that your current directory is `C:\Dev\STL\out\x64`.)
430+
428431
```
429432
python tests\utils\stl-lit\stl-lit.py ..\..\tests\std\tests\VSO_0000000_vector_algorithms -Dtags=ASAN -v
430433
```

0 commit comments

Comments
 (0)