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 | 072db59483a9b7691d9b9f863d4c12c24f83da54 (patch) | |
| tree | 2f89910bdd8fbd86ec19e58fb62a51edf13fc725 /clang | |
| parent | d30ed41c139a6ea78d484e2d44a5d6562f547a0a (diff) | |
| download | bcm5719-llvm-072db59483a9b7691d9b9f863d4c12c24f83da54.tar.gz bcm5719-llvm-072db59483a9b7691d9b9f863d4c12c24f83da54.zip | |
Rewrite docs/LeakSanitizer.rst. Add it to index.
llvm-svn: 196957
Diffstat (limited to 'clang')
| -rw-r--r-- | clang/docs/LeakSanitizer.rst | 17 | ||||
| -rw-r--r-- | clang/docs/index.rst | 6 |
2 files changed, 12 insertions, 11 deletions
diff --git a/clang/docs/LeakSanitizer.rst b/clang/docs/LeakSanitizer.rst index 2ffc57f7c4d..b1071efd1aa 100644 --- a/clang/docs/LeakSanitizer.rst +++ b/clang/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/clang/docs/index.rst b/clang/docs/index.rst index d02686422b5..b18deb9b063 100644 --- a/clang/docs/index.rst +++ b/clang/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 ======================== |
