From 1b4a38b361a0831d98defaf9d5093923f63d836c Mon Sep 17 00:00:00 2001 From: Anna Zaks Date: Thu, 27 Oct 2016 21:38:44 +0000 Subject: [PATCH] [docs] Update the TSan and MSan docs to refer to the new no_sanitize attribute TSan and MSan were the only remaining sanitizers referring to the deprecated attribute for issue suppression. Update the docs to recommend __attribute__((no_sanitize("..."))) instead. Differential Revision: https://reviews.llvm.org/D25885 git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@285349 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/MemorySanitizer.rst | 10 +++++----- docs/ThreadSanitizer.rst | 10 +++++----- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/MemorySanitizer.rst b/docs/MemorySanitizer.rst index 4e58588b80..8088ecdf56 100644 --- a/docs/MemorySanitizer.rst +++ b/docs/MemorySanitizer.rst @@ -76,14 +76,14 @@ whether MemorySanitizer is enabled. :ref:`\_\_has\_feature # endif #endif -``__attribute__((no_sanitize_memory))`` +``__attribute__((no_sanitize("memory")))`` ----------------------------------------------- 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)``. +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 cfb0a952e1..cfbaa63d64 100644 --- a/docs/ThreadSanitizer.rst +++ b/docs/ThreadSanitizer.rst @@ -83,11 +83,11 @@ this purpose. # endif #endif -``__attribute__((no_sanitize_thread))`` +``__attribute__((no_sanitize("thread")))`` ----------------------------------------------- Some code should not be instrumented by ThreadSanitizer. One may use the -function attribute `no_sanitize_thread` to disable instrumentation of plain +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 @@ -99,9 +99,9 @@ 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 -`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. +``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 ----------- -- 2.40.0