@@ -555,7 +555,7 @@ See the functional test documentation for how to invoke perf within tests.
555
555
Bitcoin Core can be compiled with various "sanitizers" enabled, which add
556
556
instrumentation for issues regarding things like memory safety, thread race
557
557
conditions, or undefined behavior. This is controlled with the
558
- ` --with-sanitizers ` configure flag, which should be a comma separated list of
558
+ ` -DSANITIZERS ` cmake build flag, which should be a comma separated list of
559
559
sanitizers to enable. The sanitizer list should correspond to supported
560
560
` -fsanitize= ` options in your compiler. These sanitizers have runtime overhead,
561
561
so they are most useful when testing changes or producing debugging builds.
@@ -564,10 +564,10 @@ Some examples:
564
564
565
565
``` bash
566
566
# Enable both the address sanitizer and the undefined behavior sanitizer
567
- ./configure --with-sanitizers =address,undefined
567
+ cmake -B build -DSANITIZERS =address,undefined
568
568
569
569
# Enable the thread sanitizer
570
- ./configure --with-sanitizers =thread
570
+ cmake -B build -DSANITIZERS =thread
571
571
```
572
572
573
573
If you are compiling with GCC you will typically need to install corresponding
@@ -589,7 +589,7 @@ See the CI config for more examples, and upstream documentation for more informa
589
589
about any additional options.
590
590
591
591
Not all sanitizer options can be enabled at the same time, e.g. trying to build
592
- with ` --with-sanitizers =address,thread ` will fail in the configure script as
592
+ with ` -DSANITIZERS =address,thread ` will fail in the configure script as
593
593
these sanitizers are mutually incompatible. Refer to your compiler manual to
594
594
learn more about these options and which sanitizers are supported by your
595
595
compiler.
@@ -603,7 +603,6 @@ Additional resources:
603
603
* [ UndefinedBehaviorSanitizer] ( https://clang.llvm.org/docs/UndefinedBehaviorSanitizer.html )
604
604
* [ GCC Instrumentation Options] ( https://gcc.gnu.org/onlinedocs/gcc/Instrumentation-Options.html )
605
605
* [ Google Sanitizers Wiki] ( https://github.com/google/sanitizers/wiki )
606
- * [ Issue #12691 : Enable -fsanitize flags in Travis] ( https://github.com/bitcoin/bitcoin/issues/12691 )
607
606
608
607
Locking/mutex usage notes
609
608
-------------------------
0 commit comments