Skip to content

Commit 75b6dfe

Browse files
rlalikStableCoder
authored andcommitted
Update of README with new sanitizer usage possibilities
1 parent 5f054fd commit 75b6dfe

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -85,16 +85,16 @@ A quick rundown of the tools available, and what they do:
8585
- Unreachable code
8686
- [MemorySanitizer](https://clang.llvm.org/docs/MemorySanitizer.html) detects uninitialized reads.
8787

88-
These are used by declaring the `USE_SANITIZER` CMake variable as one of:
88+
These are used by declaring the `USE_SANITIZER` CMake variable as string containing any of:
8989
- Address
9090
- Memory
9191
- MemoryWithOrigins
9292
- Undefined
9393
- Thread
94-
- Address;Undefined
95-
- Undefined;Address
9694
- Leak
9795

96+
Multiple values are allowed, e.g. `-DUSE_SANITIZER=Address,Leak` but some sanitizers cannot be combined together, e.g.`-DUSE_SANITIZER=Address,Memory` will result in configuration error. The delimeter character is not required and `-DUSE_SANITIZER=AddressLeak` would work as well.
97+
9898
## Code Coverage [`code-coverage.cmake`](code-coverage.cmake)
9999

100100
![Code Coverage Examples](img/code-cov.png)
@@ -362,4 +362,4 @@ Doesn't work with GCC.
362362
### Optional Arguments
363363

364364
#### REQUIRED
365-
If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported
365+
If this is passed in, CMake configuration will fail with an error if LTO/IPO is not supported

0 commit comments

Comments
 (0)