diff --git a/doc/developer-notes.md b/doc/developer-notes.md --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -215,6 +215,21 @@ CXXFLAGS="-DDEBUG_LOCKORDER -g") inserts run-time checks to keep track of which locks are held, and adds warnings to the debug.log file if inconsistencies are detected. +**Valgrind suppressions file** + +Valgrind is a programming tool for memory debugging, memory leak detection, and +profiling. The repo contains a Valgrind suppressions file +([`valgrind.supp`](contrib/valgrind.supp)) +which includes known Valgrind warnings in our dependencies that cannot be fixed +in-tree. Example use: + +```shell +$ valgrind --suppressions=contrib/valgrind.supp src/test/test_bitcoin +$ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \ + --show-leak-kinds=all src/test/test_bitcoin --log_level=test_suite +$ valgrind -v --leak-check=full src/bitcoind -printtoconsole +``` + **compiling for test coverage** LCOV can be used to generate a test coverage report based upon `make check` @@ -231,21 +246,6 @@ # A coverage report will now be accessible at `./test_bitcoin.coverage/index.html`. ``` -**Valgrind suppressions file** - -Valgrind is a programming tool for memory debugging, memory leak detection, and -profiling. The repo contains a Valgrind suppressions file -([`valgrind.supp`](contrib/valgrind.supp)) -which includes known Valgrind warnings in our dependencies that cannot be fixed -in-tree. Example use: - -```shell -$ valgrind --suppressions=contrib/valgrind.supp src/test/test_bitcoin -$ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \ - --show-leak-kinds=all src/test/test_bitcoin --log_level=test_suite -$ valgrind -v --leak-check=full src/bitcoind -printtoconsole -``` - **Sanitizers** Bitcoin ABC can be compiled with various "sanitizers" enabled, which add