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

[Sergey Matveev]

Author: smatveev
Date: Tue Dec 10 14:10:30 2013
New Revision: 196957

URL: http://llvm.org/viewvc/llvm-project?rev=196957&view=rev
Log:
Rewrite docs/LeakSanitizer.rst. Add it to index.

Modified:
    cfe/trunk/docs/LeakSanitizer.rst
    cfe/trunk/docs/index.rst

Modified: cfe/trunk/docs/LeakSanitizer.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/LeakSanitizer.rst?rev=196957&r1=196956&r2=196957&view=diff
==============================================================================
--- cfe/trunk/docs/LeakSanitizer.rst (original)
+++ cfe/trunk/docs/LeakSanitizer.rst Tue Dec 10 14:10:30 2013
@@ -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
 ================

Modified: cfe/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/cfe/trunk/docs/index.rst?rev=196957&r1=196956&r2=196957&view=diff
==============================================================================
--- cfe/trunk/docs/index.rst (original)
+++ cfe/trunk/docs/index.rst Tue Dec 10 14:10:30 2013
@@ -23,15 +23,11 @@ Using Clang as a Compiler
    ThreadSanitizer
    MemorySanitizer
    DataFlowSanitizer
+   LeakSanitizer
    SanitizerSpecialCaseList
    Modules
    FAQ
 
-.. toctree::
-   :hidden:
-
-   LeakSanitizer
-
 Using Clang as a Library
 ========================