diff options
author | Saleem Abdulrasool <compnerd@compnerd.org> | 2015-10-19 01:24:08 +0000 |
---|---|---|
committer | Saleem Abdulrasool <compnerd@compnerd.org> | 2015-10-19 01:24:08 +0000 |
commit | 9255144d53cd17eff39b5d77a07de00acf922fe4 (patch) | |
tree | 31827daf24b17ab1bbabbfc42b4e1f591974ba65 /docs | |
parent | 1457d484d19be85b73012d1616e6b56aeaf9d7ec (diff) | |
download | clang-9255144d53cd17eff39b5d77a07de00acf922fe4.tar.gz |
docs: remote stale refs
Since the attribute documentation is now auto-generated, the previous references
are no longer valid. This prevented the docs build from completing
successfully.
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@250674 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'docs')
-rw-r--r-- | docs/AddressSanitizer.rst | 11 | ||||
-rw-r--r-- | docs/MemorySanitizer.rst | 13 | ||||
-rw-r--r-- | docs/ThreadSanitizer.rst | 25 |
3 files changed, 21 insertions, 28 deletions
diff --git a/docs/AddressSanitizer.rst b/docs/AddressSanitizer.rst index 66ed3447fd..06e7da7a99 100644 --- a/docs/AddressSanitizer.rst +++ b/docs/AddressSanitizer.rst @@ -196,12 +196,11 @@ Disabling Instrumentation with ``__attribute__((no_sanitize("address")))`` -------------------------------------------------------------------------- Some code should not be instrumented by AddressSanitizer. One may use the -function attribute ``__attribute__((no_sanitize("address")))`` -(which has deprecated synonyms -:ref:`no_sanitize_address <langext-address_sanitizer>` and -`no_address_safety_analysis`) to disable instrumentation of a particular -function. This attribute may not be supported by other compilers, so we suggest -to use it together with ``__has_feature(address_sanitizer)``. +function attribute ``__attribute__((no_sanitize("address")))`` (which has +deprecated synonyms `no_sanitize_address` and `no_address_safety_analysis`) to +disable instrumentation of a particular function. This attribute may not be +supported by other compilers, so we suggest to use it together with +``__has_feature(address_sanitizer)``. Suppressing Errors in Recompiled Code (Blacklist) ------------------------------------------------- diff --git a/docs/MemorySanitizer.rst b/docs/MemorySanitizer.rst index 007e0866de..f97355fd8c 100644 --- a/docs/MemorySanitizer.rst +++ b/docs/MemorySanitizer.rst @@ -80,14 +80,11 @@ whether MemorySanitizer is enabled. :ref:`\_\_has\_feature ``__attribute__((no_sanitize_memory))`` ----------------------------------------------- -Some code should not be checked by MemorySanitizer. -One may use the function attribute -:ref:`no_sanitize_memory <langext-memory_sanitizer>` -to disable uninitialized checks in a particular function. -MemorySanitizer may still instrument such functions to avoid false positives. -This attribute may not be -supported by other compilers, so we suggest to use it together with -``__has_feature(memory_sanitizer)``. +Some code should not be checked by MemorySanitizer. One may use the function +attribute `no_sanitize_memory` to disable uninitialized checks in a particular +function. MemorySanitizer may still instrument such functions to avoid false +positives. This attribute may not be supported by other compilers, so we +suggest to use it together with ``__has_feature(memory_sanitizer)``. Blacklist --------- diff --git a/docs/ThreadSanitizer.rst b/docs/ThreadSanitizer.rst index d1aeaa8a58..9a8b14040d 100644 --- a/docs/ThreadSanitizer.rst +++ b/docs/ThreadSanitizer.rst @@ -86,25 +86,22 @@ this purpose. ``__attribute__((no_sanitize_thread))`` ----------------------------------------------- -Some code should not be instrumented by ThreadSanitizer. -One may use the function attribute -:ref:`no_sanitize_thread <langext-thread_sanitizer>` -to disable instrumentation of plain (non-atomic) loads/stores in a particular function. -ThreadSanitizer still instruments such functions to avoid false positives and -provide meaningful stack traces. -This attribute may not be -supported by other compilers, so we suggest to use it together with -``__has_feature(thread_sanitizer)``. +Some code should not be instrumented by ThreadSanitizer. One may use the +function attribute `no_sanitize_thread` to disable instrumentation of plain +(non-atomic) loads/stores in a particular function. ThreadSanitizer still +instruments such functions to avoid false positives and provide meaningful stack +traces. This attribute may not be supported by other compilers, so we suggest +to use it together with ``__has_feature(thread_sanitizer)``. Blacklist --------- ThreadSanitizer supports ``src`` and ``fun`` entity types in -:doc:`SanitizerSpecialCaseList`, that can be used to suppress data race reports in -the specified source files or functions. Unlike functions marked with -:ref:`no_sanitize_thread <langext-thread_sanitizer>` attribute, -blacklisted functions are not instrumented at all. This can lead to false positives -due to missed synchronization via atomic operations and missed stack frames in reports. +:doc:`SanitizerSpecialCaseList`, that can be used to suppress data race reports +in the specified source files or functions. Unlike functions marked with +`no_sanitize_thread` attribute, blacklisted functions are not instrumented at +all. This can lead to false positives due to missed synchronization via atomic +operations and missed stack frames in reports. Limitations ----------- |