Skip to content
Snippets Groups Projects
Commit af29996e authored by Sergey Matveev's avatar Sergey Matveev
Browse files

Rewrite docs/LeakSanitizer.rst. Add it to index.

git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@196957 91177308-0d34-0410-b5e6-96231b3b80d8
parent d40c63b1
No related branches found
No related tags found
No related merge requests found
...@@ -8,16 +8,21 @@ LeakSanitizer ...@@ -8,16 +8,21 @@ LeakSanitizer
Introduction Introduction
============ ============
LeakSanitizer is a heap leak detector which is designed to be used on top of LeakSanitizer is a run-time memory leak detector. It can be combined with
:doc:`AddressSanitizer` / :doc:`MemorySanitizer`, or as a standalone library. :doc:`AddressSanitizer` to get both memory error and leak detection.
LeakSanitizer is a run-time tool which doesn't require compiler LeakSanitizer does not introduce any additional slowdown when used in this mode.
instrumentation. The LeakSanitizer runtime can also be linked in separately to get leak detection
only, at a minimal performance cost.
Current status Current status
============== ==============
LeakSanitizer is a work in progress, currently under development for LeakSanitizer is experimental and supported only on x86\_64 Linux.
x86\_64 Linux.
The combined mode has been tested on fairly large software projects. The
stand-alone mode has received much less testing.
There are plans to support LeakSanitizer in :doc:`MemorySanitizer` builds.
More Information More Information
================ ================
......
...@@ -23,15 +23,11 @@ Using Clang as a Compiler ...@@ -23,15 +23,11 @@ Using Clang as a Compiler
ThreadSanitizer ThreadSanitizer
MemorySanitizer MemorySanitizer
DataFlowSanitizer DataFlowSanitizer
LeakSanitizer
SanitizerSpecialCaseList SanitizerSpecialCaseList
Modules Modules
FAQ FAQ
.. toctree::
:hidden:
LeakSanitizer
Using Clang as a Library Using Clang as a Library
======================== ========================
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment