[docs][clang] Add extra information inside -fsanitize=unsigned-shift-base for Undefin...
authoraabhinavg <tiwariabhinavak@gmail.com>
Fri, 31 Mar 2023 04:02:52 +0000 (09:32 +0530)
committeraabhinavg <tiwariabhinavak@gmail.com>
Fri, 31 Mar 2023 04:05:15 +0000 (09:35 +0530)
Close: #60712

Reviewed By: MaskRay

Differential Revision: https://reviews.llvm.org/D146947

clang/docs/UndefinedBehaviorSanitizer.rst

index a6fac18..ce705ad 100644 (file)
@@ -157,7 +157,8 @@ Available checks are:
      ``-fsanitize=shift-exponent`` to check only left-hand side or
      right-hand side of shift operation, respectively.
   -  ``-fsanitize=unsigned-shift-base``: check that an unsigned left-hand side of
-     a left shift operation doesn't overflow.
+     a left shift operation doesn't overflow. Issues caught by this sanitizer are 
+     not undefined behavior, but are often unintentional.
   -  ``-fsanitize=signed-integer-overflow``: Signed integer overflow, where the
      result of a signed integer computation cannot be represented in its type.
      This includes all the checks covered by ``-ftrapv``, as well as checks for