From: Benoît Ganne Date: Mon, 11 May 2020 13:53:54 +0000 (+0200) Subject: docs: asan: update doc to match current status X-Git-Tag: v21.01-rc0~371 X-Git-Url: https://gerrit.fd.io/r/gitweb?a=commitdiff_plain;h=ca86c95a3413214110a03b001d45d018385b92dc;p=vpp.git docs: asan: update doc to match current status Type: docs Change-Id: I45265876c9c778f6b91d39f30eb6035f14d166ec Signed-off-by: Benoît Ganne --- diff --git a/docs/troubleshooting/sanitizer.rst b/docs/troubleshooting/sanitizer.rst index a63720ffe42..cbe72bcc9f5 100644 --- a/docs/troubleshooting/sanitizer.rst +++ b/docs/troubleshooting/sanitizer.rst @@ -6,7 +6,7 @@ Google Sanitizers VPP is instrumented to support `Google Sanitizers `_. As of today, only `AddressSanitizer `_ -is supported and only for the heap. +is supported, only for GCC and only for the heap. 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: - $ 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: - $ 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: - $ 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 - $ 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