]> granicus.if.org Git - clang/commitdiff
[ubsan] docs: Add a note about pointers to volatile
authorVedant Kumar <vsk@apple.com>
Fri, 16 Jun 2017 18:38:43 +0000 (18:38 +0000)
committerVedant Kumar <vsk@apple.com>
Fri, 16 Jun 2017 18:38:43 +0000 (18:38 +0000)
git-svn-id: https://llvm.org/svn/llvm-project/cfe/trunk@305568 91177308-0d34-0410-b5e6-96231b3b80d8

docs/UndefinedBehaviorSanitizer.rst

index ea776a7704705297290291446f07fc46019b182e..85dd549baaf80105ef0bee9c5d5a7cd256cfafbd 100644 (file)
@@ -148,6 +148,12 @@ You can also use the following check groups:
      nullability does not have undefined behavior, it is often unintentional,
      so UBSan offers to catch it.
 
+Volatile
+--------
+
+The ``null``, ``alignment``, ``object-size``, and ``vptr`` checks do not apply
+to pointers to types with the ``volatile`` qualifier.
+
 Stack traces and report symbolization
 =====================================
 If you want UBSan to print symbolized stack trace for each error report, you