diff options
| author | Sergey Matveev <earthdok@google.com> | 2013-12-10 20:13:58 +0000 |
|---|---|---|
| committer | Sergey Matveev <earthdok@google.com> | 2013-12-10 20:13:58 +0000 |
| commit | f657846ef950b25c405e353f4877f46b99261ab0 (patch) | |
| tree | de9a7ca225a87fc9cf52d37b9d90a72bd1b3b0a8 | |
| parent | 2b3c4937d643743717b13bd8a374a72bc0eb7542 (diff) | |
Merging r196957:
------------------------------------------------------------------------
r196957 | smatveev | 2013-12-11 00:10:30 +0400 (Wed, 11 Dec 2013) | 1 line
Rewrite docs/LeakSanitizer.rst. Add it to index.
------------------------------------------------------------------------
git-svn-id: https://llvm.org/svn/llvm-project/cfe/branches/release_34@196958 91177308-0d34-0410-b5e6-96231b3b80d8
| -rw-r--r-- | docs/LeakSanitizer.rst | 17 | ||||
| -rw-r--r-- | docs/index.rst | 6 |
2 files changed, 12 insertions, 11 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 ================ diff --git a/docs/index.rst b/docs/index.rst index d02686422b..b18deb9b06 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -23,15 +23,11 @@ Using Clang as a Compiler ThreadSanitizer MemorySanitizer DataFlowSanitizer + LeakSanitizer SanitizerSpecialCaseList Modules FAQ -.. toctree:: - :hidden: - - LeakSanitizer - Using Clang as a Library ======================== |