From fa514caad75def4286593c5f9a0a97a1552736f1 Mon Sep 17 00:00:00 2001 From: MarcoFalke <*~=`'#}+{/-|&$^_@721217.xyz> Date: Fri, 15 May 2026 08:26:57 +0200 Subject: [PATCH] doc: move-only Valgrind section Valgrind is often used as a sanitizer, so move it closer to the Sanitizer section. --- doc/developer-notes.md | 31 +++++++++++++++---------------- 1 file changed, 15 insertions(+), 16 deletions(-) diff --git a/doc/developer-notes.md b/doc/developer-notes.md index d6820e002cc..94b33632e65 100644 --- a/doc/developer-notes.md +++ b/doc/developer-notes.md @@ -394,22 +394,6 @@ other input. assumption may or may not result in a slightly degraded user experience, but it is safe to continue program execution. -### 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`](/test/sanitizer_suppressions/valgrind.supp)) -which includes known Valgrind warnings in our dependencies that cannot be fixed -in-tree. Example use: - -```shell -$ valgrind --suppressions=test/sanitizer_suppressions/valgrind.supp build/bin/test_bitcoin -$ valgrind --suppressions=test/sanitizer_suppressions/valgrind.supp --leak-check=full \ - --show-leak-kinds=all build/bin/test_bitcoin --log_level=test_suite -$ valgrind -v --leak-check=full build/bin/bitcoind -printtoconsole -$ ./build/test/functional/test_runner.py --valgrind -``` - ### Compiling for test coverage #### Using LCOV @@ -617,6 +601,21 @@ or using a graphical tool like [Hotspot](https://github.com/KDAB/hotspot). See the functional test documentation for how to invoke perf within tests. +### Valgrind + +Valgrind is a programming tool for memory debugging, memory leak detection, and +profiling. The repo contains a Valgrind suppressions file +([`valgrind.supp`](/test/sanitizer_suppressions/valgrind.supp)) +which includes known Valgrind warnings in our dependencies that cannot be fixed +in-tree. Example use: + +```shell +$ valgrind --suppressions=test/sanitizer_suppressions/valgrind.supp build/bin/test_bitcoin +$ valgrind --suppressions=test/sanitizer_suppressions/valgrind.supp --leak-check=full \ + --show-leak-kinds=all build/bin/test_bitcoin --log_level=test_suite +$ valgrind -v --leak-check=full build/bin/bitcoind -printtoconsole +$ ./build/test/functional/test_runner.py --valgrind +``` ### Sanitizers