Skip to content

Commit 4a426d8

Browse files
Add note about Valgrind suppressions file in developer-notes.md
1 parent 84e2462 commit 4a426d8

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

doc/developer-notes.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -165,6 +165,21 @@ can be very difficult to track down. Compiling with -DDEBUG_LOCKORDER (configure
165165
CXXFLAGS="-DDEBUG_LOCKORDER -g") inserts run-time checks to keep track of which locks
166166
are held, and adds warnings to the debug.log file if inconsistencies are detected.
167167

168+
**Valgrind suppressions file**
169+
170+
Valgrind is a programming tool for memory debugging, memory leak detection, and
171+
profiling. The repo contains a Valgrind suppressions file
172+
([`valgrind.supp`](https://github.com/bitcoin/bitcoin/blob/master/contrib/valgrind.supp))
173+
which includes known Valgrind warnings in our dependencies that cannot be fixed
174+
in-tree. Example use:
175+
176+
```shell
177+
$ valgrind --suppressions=contrib/valgrind.supp src/test/test_bitcoin
178+
$ valgrind --suppressions=contrib/valgrind.supp --leak-check=full \
179+
--show-leak-kinds=all src/test/test_bitcoin --log_level=test_suite
180+
$ valgrind -v --leak-check=full src/bitcoind -printtoconsole
181+
```
182+
168183
Locking/mutex usage notes
169184
-------------------------
170185

0 commit comments

Comments
 (0)