phantom/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-04-29 14:59:39 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

docs: updated developer notes for --with-sanitizers to -DSANITIZERS and removed resource for -fsanitze flags

Browse source
This commit is contained in:
kevkevinpal 2024-09-11 09:21:46 -04:00
parent 0725a37494
commit 4b1ce3cac8
No known key found for this signature in database
GPG key ID: B4346A15246A925D
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
doc/developer-notes.md
View file

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