diff options
| author | Sergey Matveev <earthdok@google.com> | 2013-12-10 20:10:30 +0000 |
|---|---|---|
| committer | Sergey Matveev <earthdok@google.com> | 2013-12-10 20:10:30 +0000 |
| commit | af29996ea81c7c0e3e621a0712be71b7dd76964a (patch) | |
| tree | 781a39692d14604da991e995f32f38a66f8a8929 /docs/LeakSanitizer.rst | |
| parent | d40c63b1684171770a9456a3dba56edf589d5590 (diff) | |
| download | clang-af29996ea81c7c0e3e621a0712be71b7dd76964a.tar.gz clang-af29996ea81c7c0e3e621a0712be71b7dd76964a.tar.bz2 clang-af29996ea81c7c0e3e621a0712be71b7dd76964a.tar.xz | |
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
Diffstat (limited to 'docs/LeakSanitizer.rst')
| -rw-r--r-- | docs/LeakSanitizer.rst | 17 |
1 files changed, 11 insertions, 6 deletions
diff --git a/docs/LeakSanitizer.rst b/docs/LeakSanitizer.rst index 2ffc57f7c4..b1071efd1a 100644 --- a/docs/LeakSanitizer.rst +++ b/docs/LeakSanitizer.rst @@ -8,16 +8,21 @@ LeakSanitizer Introduction ============ -LeakSanitizer is a heap leak detector which is designed to be used on top of -:doc:`AddressSanitizer` / :doc:`MemorySanitizer`, or as a standalone library. -LeakSanitizer is a run-time tool which doesn't require compiler -instrumentation. +LeakSanitizer is a run-time memory leak detector. It can be combined with +:doc:`AddressSanitizer` to get both memory error and leak detection. +LeakSanitizer does not introduce any additional slowdown when used in this mode. +The LeakSanitizer runtime can also be linked in separately to get leak detection +only, at a minimal performance cost. Current status ============== -LeakSanitizer is a work in progress, currently under development for -x86\_64 Linux. +LeakSanitizer is experimental and supported only on 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 ================ |