[PATCH] D12914: Updating docs for poison-in-dtor.

[Naomi Musgrave via llvm-commits]

nmusgrave updated this revision to Diff 34945.
nmusgrave marked an inline comment as done.
nmusgrave added a comment.

- Change wording to specify memory no longer readable.


http://reviews.llvm.org/D12914

Files:
  docs/UsersManual.rst

Index: docs/UsersManual.rst
===================================================================
--- docs/UsersManual.rst
+++ docs/UsersManual.rst
@@ -1065,6 +1065,16 @@
       order of memory stores the uninitialized value went
       through. This mode may use extra memory in programs that copy
       uninitialized memory a lot.
+   -  ``-fsanitize-memory-use-after-dtor``: Enables use-after-destruction
+      detection in MemorySanitizer. After invocation of the destructor,
+      the object is considered no longer readable. Facilitates the
+      detection of use-after-destroy bugs.
+
+      Setting the MSAN_OPTIONS=poison_in_dtor=1 enables the poisoning of
+      memory at runtime. Any subsequent access to the destroyed object
+      fails at runtime. This feature is still experimental, but this
+      environment variable must be set to 1 in order for the above flag
+      to have any effect.
 
    The ``-fsanitize=`` argument must also be provided when linking, in
    order to link to the appropriate runtime library. When using


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D12914.34945.patch
Type: text/x-patch
Size: 1049 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20150917/05349d76/attachment.bin>