What the developer wrote
Authored by MarcoFalke
doc: move-only Valgrind section
Valgrind is often used as a sanitizer, so move it closer to the Sanitizer section.
What changed, and why it matters
This commit simply moves the existing Valgrind documentation section to a different place in the developer notes file. No code, configuration, or behavior changed. It is purely a documentation reorganization.
No action needed. This is a non-functional documentation change.
Security signals we found
No strong security signals were identified.
Evidence from the diff
The patch is a move-only edit in doc/developer-notes.md. It removes the ‘Valgrind suppressions file’ subsection from one location and reinserts it under a shortened ‘Valgrind’ heading near the ‘Sanitizers’ section. The text and example commands are unchanged. There are no functional modifications to Bitcoin Core.
Changed components
doc/developer-notes.mdInspect captured patch +15 / −16
diff --git a/doc/developer-notes.md b/doc/developer-notes.md
index d6820e00..94b33632 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
Why this scored 15/100
Community notes
Notes can correct, qualify, or add evidence to the AI analysis. Every note shown here has been validated by a human moderator.
The AI analysis stands alone for now. Submit a note if you can add evidence or important context.