doc: Document the usage of --enable-undefined-sanitizer

Signed-off-by: Donald Sharp <sharpd@nvidia.com>

diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst
index f720f6279ef2863700e65d7c13d98eaf859198d0..166c96da33c66bf6f7bfc5bc8a3b394f34443d52 100644 (file)
--- a/doc/developer/workflow.rst
+++ b/doc/developer/workflow.rst
@@ -1306,6 +1306,16 @@ MemorySanitizer
 
    to ``configure``.
 
+UndefinedSanitizer
+   Similar to AddressSanitizer, this tool provides runtime instrumentation for
+   detecting use of undefined behavior in C.  Testing your own code with this
+   tool before submission is encouraged.  You can enable it by passing::
+
+      --enable-undefined-sanitizer
+
+    to ``configure``.  If you run FRR with this you will probably also have
+    to set ``sudo sysctl vm.mmap_rnd_bits=28``
+
 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.