docs: asan: update doc to match current status

Type: docs

Change-Id: I45265876c9c778f6b91d39f30eb6035f14d166ec
Signed-off-by: Benoît Ganne <bganne@cisco.com>

diff --git a/docs/troubleshooting/sanitizer.rst b/docs/troubleshooting/sanitizer.rst
index a63720f..cbe72bc 100644 (file)
--- a/docs/troubleshooting/sanitizer.rst
+++ b/docs/troubleshooting/sanitizer.rst
@@ -6,7 +6,7 @@ Google Sanitizers
 
 VPP is instrumented to support `Google Sanitizers <https://github.com/google/sanitizers>`_.
 As of today, only `AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_
 
 VPP is instrumented to support `Google Sanitizers <https://github.com/google/sanitizers>`_.
 As of today, only `AddressSanitizer <https://github.com/google/sanitizers/wiki/AddressSanitizer>`_

-is supported and only for the heap.
+is supported, only for GCC and only for the heap.

 
 AddressSanitizer
 ================
 
 AddressSanitizer
 ================


@@ -20,19 +20,19 @@ build option, so all VPP targets should be supported. For example:
 .. code-block:: console
 
     # build a debug image with ASan support:
 .. code-block:: console
 
     # build a debug image with ASan support:

-    $ make rebuild VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+    $ make rebuild VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8

     ....
 
     # build a release image with ASan support:
     ....
 
     # build a release image with ASan support:

-    $ make rebuild-release VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+    $ make rebuild-release VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8

     ....
 
     # build packages in debug mode with ASan support:
     ....
 
     # build packages in debug mode with ASan support:

-    $ make pkg-deb-debug VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+    $ make pkg-deb-debug VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8

     ....
 
     # run GBP plugin tests in debug mode with ASan
     ....
 
     # run GBP plugin tests in debug mode with ASan

-    $ make test-debug TEST=test_gbp VPP_EXTRA_CMAKE_ARGS=-DENABLE_SANITIZE_ADDR=ON
+    $ make test-debug TEST=test_gbp VPP_EXTRA_CMAKE_ARGS=-DVPP_ENABLE_SANITIZE_ADDR=ON CC=gcc-8

     ....
 
 Once VPP has been built with ASan support you can use it as usual including
     ....
 
 Once VPP has been built with ASan support you can use it as usual including