summaryrefslogtreecommitdiff
path: root/doc/developer
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@users.noreply.github.com>2021-06-16 18:57:25 +0000
committerGitHub <noreply@github.com>2021-06-16 18:57:25 +0000
commit9b1bc4d661381a822d3285b62177c182ede8afcc (patch)
tree21f519f2b395eec6be35c4e127849de0f8ed43af /doc/developer
parent40e528205904c50732bf620fb1fefbde3f9f71e6 (diff)
parente58133a78e2d814cb23f9bd850f6551075a831ae (diff)
Merge pull request #8856 from LabNConsulting/chopps/topo-valgrind
Diffstat (limited to 'doc/developer')
-rw-r--r--doc/developer/topotests.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst
index 8885dcfce3..ba03aa9045 100644
--- a/doc/developer/topotests.rst
+++ b/doc/developer/topotests.rst
@@ -312,6 +312,20 @@ Here's an example of launching ``zebra`` and ``bgpd`` inside ``gdb`` on router
--gdb-breakpoints=nb_config_diff \
all-protocol-startup
+Detecting Memleaks with Valgrind
+""""""""""""""""""""""""""""""""
+
+Topotest can automatically launch all daemons with ``valgrind`` to check for
+memleaks. This is enabled by specifying 1 or 2 CLI arguments.
+``--valgrind-memleaks`` will enable general memleak detection, and
+``--valgrind-extra`` enables extra functionality including generating a
+suppression file. The suppression file ``tools/valgrind.supp`` is used when
+memleak detection is enabled.
+
+.. code:: shell
+
+ pytest --valgrind-memleaks all-protocol-startup
+
.. _topotests_docker:
Running Tests with Docker