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

Merge pull request #4442 from opensourcerouting/libtool-doc

Browse Source 
doc: add libtool note
This commit is contained in:
Donald Sharp 2019-06-02 18:54:24 -04:00 committed by GitHub
commit a0d1226e23
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
doc/developer/workflow.rst
View File

@ -750,7 +750,8 @@ developer will use this convention to allow control of their debugs.
Static Analysis and Sanitizers
------------------------------
Clang/LLVM comes with a variety of tools that can be used to help find bugs in FRR.
Clang/LLVM and GCC come with a variety of tools that can be used to help find
bugs in FRR.
clang-analyze
This is a static analyzer that scans the source code looking for patterns
@ -794,11 +795,31 @@ All of the above tools are available in the Clang/LLVM toolchain since 3.4.
AddressSanitizer and ThreadSanitizer are available in recent versions of GCC,
but are no longer actively maintained. MemorySanitizer is not available in GCC.
.. note::
The different Sanitizers are mostly incompatible with each other. Please
refer to GCC/LLVM documentation for details.
Additionally, the FRR codebase is regularly scanned with Coverity.
Unfortunately Coverity does not have the ability to handle scanning pull
requests, but after code is merged it will send an email notifying project
members with Coverity access of newly introduced defects.
Executing non-installed dynamic binaries
----------------------------------------
Since FRR uses the GNU autotools build system, it inherits its shortcomings.
To execute a binary directly from the build tree under a wrapper like
`valgrind`, `gdb` or `strace`, use::
./libtool --mode=execute valgrind [--valgrind-opts] zebra/zebra [--zebra-opts]
While replacing valgrind/zebra as needed. The `libtool` script is found in
the root of the build directory after `./configure` has completed. Its purpose
is to correctly set up `LD_LIBRARY_PATH` so that libraries from the build tree
are used. (On some systems, `libtool` is also available from PATH, but this is
not always the case.)
CLI changes
-----------