summaryrefslogtreecommitdiff
path: root/docs/AddressSanitizer.rst
diff options
context:
space:
mode:
authorAlexey Samsonov <vonosmas@gmail.com>2016-01-22 01:35:45 +0000
committerAlexey Samsonov <vonosmas@gmail.com>2016-01-22 01:35:45 +0000
commitf06e83bf0e3f13f78b1b4e8cfdd0428dfd1cb88d (patch)
tree24622c918dd74237f9629c8674f71853db67e15c /docs/AddressSanitizer.rst
parent0b95b25f8ef067af4e15d8a3df46ce4732910bc0 (diff)
downloadclang-f06e83bf0e3f13f78b1b4e8cfdd0428dfd1cb88d.tar.gz
[Docs] Slightly update LSan documentation.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@258476 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs/AddressSanitizer.rst')
-rw-r--r--docs/AddressSanitizer.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/AddressSanitizer.rst b/docs/AddressSanitizer.rst
index 93f6314321..a42a1ff623 100644
--- a/docs/AddressSanitizer.rst
+++ b/docs/AddressSanitizer.rst
@@ -232,6 +232,23 @@ problems happening in certain source files or with certain global variables.
type:*BadInitClassSubstring*=init
src:bad/init/files/*=init
+Suppressing memory leaks
+------------------------
+
+Memory leak reports produced by :doc:`LeakSanitizer` (if it is run as a part
+of AddressSanitizer) can be suppressed by a separate file passed as
+
+.. code-block:: bash
+
+ LSAN_OPTIONS=suppressions=MyLSan.supp
+
+which contains lines of the form `leak:<pattern>`. Memory leak will be
+suppressed if pattern matches any function name, source file name, or
+library name in the symbolized stack trace of the leak report. See
+`full documentation
+<https://github.com/google/sanitizers/wiki/AddressSanitizerLeakSanitizer#suppressions>`_
+for more details.
+
Limitations
===========