proxmox-mirrors/mirror_frr
1
0
Fork 0
mirror of https://git.proxmox.com/git/mirror_frr synced 2025-08-08 22:22:16 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc: clean up memleak section of topotests doc

Browse Source 
Cleaned up some repetition (cut-and-paste?) in the topotests
developer doc.

Signed-off-by: Mark Stapp <mjs@voltanet.io>
This commit is contained in:
Mark Stapp 2019-05-29 11:45:02 -04:00
parent 4c02c06489
commit e60aaed91d
1 changed files with 9 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
doc/developer/topotests.rst
View File

@ -145,30 +145,23 @@ the following env variable can be set::
export TOPOTESTS_CHECK_STDERR=Yes export TOPOTESTS_CHECK_STDERR=Yes
(The value doesn't matter at this time. The check is if the env variable exists (The value doesn't matter at this time. The check is whether the env
or not) There is no pass/fail on this reporting. The Output will be reported to variable exists or not.) There is no pass/fail on this reporting; the
the console:: Output will be reported to the console.
export TOPOTESTS_CHECK_MEMLEAK="/home/mydir/memleak_"
This will enable the check and output to console and the writing of the
information to files with the given prefix (followed by testname), ie
:file:`/home/mydir/memcheck_test_bgp_multiview_topo1.txt` in case of a memory
leak.
Collect Memory Leak Information Collect Memory Leak Information
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
FRR processes have the capabilities to report remaining memory allocations upon FRR processes can report unfreed memory allocations upon exit. To
exit. To enable the reporting of the memory, define an environment variable enable the reporting of memory leaks, define an environment variable
``TOPOTESTS_CHECK_MEMLEAK`` with the file prefix, i.e.:: ``TOPOTESTS_CHECK_MEMLEAK`` with the file prefix, i.e.::
export TOPOTESTS_CHECK_MEMLEAK="/home/mydir/memleak_" export TOPOTESTS_CHECK_MEMLEAK="/home/mydir/memleak_"
This will enable the check and output to console and the writing of the This will enable the check and output to console and the writing of
information to files with the given prefix (followed by testname), ie the information to files with the given prefix (followed by testname),
:file:`/home/mydir/memcheck_test_bgp_multiview_topo1.txt` in case of a memory ie :file:`/home/mydir/memcheck_test_bgp_multiview_topo1.txt` in case
leak. of a memory leak.
Running Topotests with AddressSanitizer Running Topotests with AddressSanitizer
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^