diff options
| author | Donald Sharp <sharpd@cumulusnetworks.com> | 2019-05-31 03:20:24 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-31 03:20:24 +0200 |
| commit | 7ee965ca4bd7207cfd6c0809f06105922e135b13 (patch) | |
| tree | 4f077518f1341338613c6cc20f6a6ff7e656142e /doc | |
| parent | Merge pull request #4413 from donaldsharp/bgp_distance_comes_closer (diff) | |
| parent | doc: clean up memleak section of topotests doc (diff) | |
| download | frr-7ee965ca4bd7207cfd6c0809f06105922e135b13.tar.xz frr-7ee965ca4bd7207cfd6c0809f06105922e135b13.zip | |
Merge pull request #4427 from mjstapp/fix_topo_memleak
doc: clean up memleak section of topotests doc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer/topotests.rst | 25 |
1 files changed, 9 insertions, 16 deletions
diff --git a/doc/developer/topotests.rst b/doc/developer/topotests.rst index 09f12ec43..e12bc3725 100644 --- a/doc/developer/topotests.rst +++ b/doc/developer/topotests.rst @@ -145,30 +145,23 @@ the following env variable can be set:: export TOPOTESTS_CHECK_STDERR=Yes -(The value doesn't matter at this time. The check is if the env variable exists -or not) There is no pass/fail on this reporting. The 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. +(The value doesn't matter at this time. The check is whether the env +variable exists or not.) There is no pass/fail on this reporting; the +Output will be reported to the console. Collect Memory Leak Information ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -FRR processes have the capabilities to report remaining memory allocations upon -exit. To enable the reporting of the memory, define an environment variable +FRR processes can report unfreed memory allocations upon exit. To +enable the reporting of memory leaks, define an environment variable ``TOPOTESTS_CHECK_MEMLEAK`` with the file prefix, i.e.:: 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. +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. Running Topotests with AddressSanitizer ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |