Actualize docs

Author: denzor200

clang-tools-extra/clang-tidy/misc/BoolBitwiseOperationCheck.cpp

@@ -133,12 +133,12 @@ static const Expr *getAcceptableCompoundsLHS(const BinaryOperator *BinOp) {
 BoolBitwiseOperationCheck::BoolBitwiseOperationCheck(StringRef Name,
                                                      ClangTidyContext *Context)
     : ClangTidyCheck(Name, Context),
-      StrictMode(Options.get("StrictMode", false)),
+      UnsafeMode(Options.get("UnsafeMode", false)),
       IgnoreMacros(Options.get("IgnoreMacros", false)) {}
 
 void BoolBitwiseOperationCheck::storeOptions(
     ClangTidyOptions::OptionMap &Opts) {
-  Options.store(Opts, "StrictMode", StrictMode);
+  Options.store(Opts, "UnsafeMode", UnsafeMode);
   Options.store(Opts, "IgnoreMacros", IgnoreMacros);
 }
 
@@ -174,7 +174,7 @@ void BoolBitwiseOperationCheck::emitWarningAndChangeOperatorsIfPossible(
   }
 
   const bool HasSideEffects = BinOp->getRHS()->HasSideEffects(
-      Ctx, /*IncludePossibleEffects=*/!StrictMode);
+      Ctx, /*IncludePossibleEffects=*/!UnsafeMode);
   if (HasSideEffects) {
     DiagEmitter();
     return;

clang-tools-extra/clang-tidy/misc/BoolBitwiseOperationCheck.h

@@ -42,7 +42,7 @@ class BoolBitwiseOperationCheck : public ClangTidyCheck {
                             clang::ASTContext &Ctx,
                             std::optional<bool> &RootAssignsToBoolean);
 
-  bool StrictMode;
+  bool UnsafeMode;
   bool IgnoreMacros;
 };
 

clang-tools-extra/docs/clang-tidy/checks/misc/bool-bitwise-operation.rst

@@ -14,8 +14,17 @@ to implicit integer conversions and missed short-circuit evaluation.
 
   bool invalid = false;
   invalid |= x > limit.x; // warning: use logical operator '||' for boolean semantics instead of bitwise operator '|='
+                          //   400 |     invalid |= x > limit.x;
+                          //       |             ^~
+                          //       |             = invalid ||
   invalid |= y > limit.y; // warning: use logical operator '||' for boolean semantics instead of bitwise operator '|='
+                          //   401 |     invalid |= y > limit.y;
+                          //       |             ^~
+                          //       |             = invalid ||
   invalid |= z > limit.z; // warning: use logical operator '||' for boolean semantics instead of bitwise operator '|='
+                          //   402 |     invalid |= z > limit.z;
+                          //       |             ^~
+                          //       |             = invalid ||
   if (invalid) {
     // error handling
   }
@@ -33,24 +42,30 @@ instead of using the ``|=`` operator:
     // error handling
   }
 
+It is not always a safe transformation though. The following case will warn
+without fix-it to preserve the semantics.
+
+.. code-block:: c++
+
+  volatile bool invalid = false;
+  invalid |= x > limit.x; // warning: use logical operator '||' for boolean semantics instead of bitwise operator '|='
+
 Limitations
 -----------
 
-* Bitwise operators inside templates aren't matched.
+* Bitwise operators inside templates aren't guaranteed to match.
 
 .. code-block:: c++
 
      template <typename X>
      void f(X a, X b) {
-         a | b;
+         a | b; // the warning may not be emited
      }
 
-     // even 'f(true, false)' (or similar) won't trigger the warning.
-
 Options
 -------
 
-.. option:: StrictMode
+.. option:: UnsafeMode
 
     Enabling this option promotes more fix-it hints even when they might
     change evaluation order or skip side effects. Default value is `false`.

clang-tools-extra/test/clang-tidy/checkers/misc/bool-bitwise-operation-change-possible-side-effect.cpp

@@ -1,6 +1,6 @@
 // RUN: %check_clang_tidy %s misc-bool-bitwise-operation %t \
 // RUN:   -config="{CheckOptions: { \
-// RUN:     misc-bool-bitwise-operation.StrictMode: true }}"
+// RUN:     misc-bool-bitwise-operation.UnsafeMode: true }}"
 
 bool function_with_possible_side_effects();