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

[Evgeniy Stepanov via llvm-commits]

eugenis added inline comments.

================
Comment at: docs/UsersManual.rst:1068
@@ -1067,1 +1067,3 @@
       uninitialized memory a lot.
+   -  ``-fsanitize-memory-use-after-dtor``: Enables destructor poisoning in
+      MemorySanitizer. Facilitates the detection of use-after-destroy bugs,
----------------
This is a user-facing manual, avoid using specialized terms like "poisoning". Say that this enabled use-after-destruction detection and that with this the object memory is considered uninitialized after the destructor has run.

================
Comment at: docs/UsersManual.rst:1072
@@ +1071,3 @@
+
+      Setting the MSAN_OPTIONS=poison_in_dtor=1 enables the poisoning of
+      memory at runtime. Any subsequent access to the poisoned memory
----------------
Until poison_in_dtor defaults to 1, we should consider this feature experimental. Say so, and make it clear that poison_in_dtor=1 is required for the flag to have any effect.


================
Comment at: docs/UsersManual.rst:1074
@@ -1068,1 +1073,3 @@
+      memory at runtime. Any subsequent access to the poisoned memory
+      region fails.
 
----------------
not "fails", but is reported as a use of uninitialized value


http://reviews.llvm.org/D12914