Skip to content

Commit af29996

Browse files
committed
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
1 parent d40c63b commit af29996

File tree

2 files changed

+12
-11
lines changed

2 files changed

+12
-11
lines changed

docs/LeakSanitizer.rst

+11-6
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,21 @@ LeakSanitizer
88
Introduction
99
============
1010

11-
LeakSanitizer is a heap leak detector which is designed to be used on top of
12-
:doc:`AddressSanitizer` / :doc:`MemorySanitizer`, or as a standalone library.
13-
LeakSanitizer is a run-time tool which doesn't require compiler
14-
instrumentation.
11+
LeakSanitizer is a run-time memory leak detector. It can be combined with
12+
:doc:`AddressSanitizer` to get both memory error and leak detection.
13+
LeakSanitizer does not introduce any additional slowdown when used in this mode.
14+
The LeakSanitizer runtime can also be linked in separately to get leak detection
15+
only, at a minimal performance cost.
1516

1617
Current status
1718
==============
1819

19-
LeakSanitizer is a work in progress, currently under development for
20-
x86\_64 Linux.
20+
LeakSanitizer is experimental and supported only on x86\_64 Linux.
21+
22+
The combined mode has been tested on fairly large software projects. The
23+
stand-alone mode has received much less testing.
24+
25+
There are plans to support LeakSanitizer in :doc:`MemorySanitizer` builds.
2126

2227
More Information
2328
================

docs/index.rst

+1-5
Original file line numberDiff line numberDiff line change
@@ -23,15 +23,11 @@ Using Clang as a Compiler
2323
ThreadSanitizer
2424
MemorySanitizer
2525
DataFlowSanitizer
26+
LeakSanitizer
2627
SanitizerSpecialCaseList
2728
Modules
2829
FAQ
2930

30-
.. toctree::
31-
:hidden:
32-
33-
LeakSanitizer
34-
3531
Using Clang as a Library
3632
========================
3733

0 commit comments

Comments
 (0)