[clang-tidy][doc][NFC] extract common global options in doc

HerrCai0907 · HerrCai0907 · commit efe9cd9e7898 · 2024-12-13T17:09:32.000+08:00
diff --git a/clang-tools-extra/docs/clang-tidy/GlobalOptions.rst b/clang-tools-extra/docs/clang-tidy/GlobalOptions.rst
@@ -0,0 +1,21 @@
+==============
+Global Options
+==============
+
+Some options apply to multiple checks. This page lists all the available
+globally options.
+
+.. option:: IncludeStyle
+
+   A string specifying which include-style is used, `llvm` or `google`. Default
+   is `llvm`.
+
+.. option:: IgnoreMacros
+
+   If set to `true`, the check will not give warnings inside macros. Default
+   is `true`.
+
+.. option:: StrictMode
+
+  When `true`, some checkers will be more stringent. The default value depends
+  on the checks.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/abseil/string-find-startswith.rst b/clang-tools-extra/docs/clang-tidy/checks/abseil/string-find-startswith.rst
@@ -39,8 +39,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: AbseilStringsMatchHeader
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/abseil/string-find-str-contains.rst b/clang-tools-extra/docs/clang-tidy/checks/abseil/string-find-str-contains.rst
@@ -43,8 +43,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: AbseilStringsMatchHeader
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/boost/use-ranges.rst b/clang-tools-extra/docs/clang-tidy/checks/boost/use-ranges.rst
@@ -162,8 +162,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IncludeBoostSystem
    
diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines/avoid-do-while.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines/avoid-do-while.rst
@@ -26,7 +26,8 @@ Options
 
 .. option:: IgnoreMacros
 
-  Ignore the check when analyzing macros. This is useful for safely defining function-like macros:
+  See :doc:`global options <clang-tidy/GlobalOptions>`.
+  This is useful for safely defining function-like macros:
 
   .. code-block:: c++
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines/init-variables.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines/init-variables.rst
@@ -62,8 +62,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: MathHeader
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines/pro-bounds-constant-array-index.rst b/clang-tools-extra/docs/clang-tidy/checks/cppcoreguidelines/pro-bounds-constant-array-index.rst
@@ -24,5 +24,4 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc/uniqueptr-reset-release.rst b/clang-tools-extra/docs/clang-tidy/checks/misc/uniqueptr-reset-release.rst
@@ -20,5 +20,4 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/loop-convert.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/loop-convert.rst
@@ -169,8 +169,7 @@ lives.
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 Limitations
 -----------
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/make-shared.rst
@@ -41,13 +41,11 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreDefaultInitialization
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/make-unique.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/make-unique.rst
@@ -41,13 +41,11 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreDefaultInitialization
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/min-max-use-initializer-list.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/min-max-use-initializer-list.rst
@@ -37,8 +37,7 @@ Options
 
 .. option:: IncludeStyle
 
-  A string specifying which include-style is used, `llvm` or `google`. Default
-  is `llvm`.
+  See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreNonTrivialTypes
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/pass-by-value.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/pass-by-value.rst
@@ -157,8 +157,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: ValuesOnly
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/replace-auto-ptr.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/replace-auto-ptr.rst
@@ -75,5 +75,4 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/type-traits.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/type-traits.rst
@@ -29,7 +29,7 @@ Options
 
 .. option:: IgnoreMacros
 
-  If `true` don't diagnose traits defined in macros.
+  See :doc:`global options <clang-tidy/GlobalOptions>`.
 
   Note: Fixes will never be emitted for code inside of macros.
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-bool-literals.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-bool-literals.rst
@@ -24,5 +24,4 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-default-member-init.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-default-member-init.rst
@@ -50,5 +50,4 @@ Options
 
 .. option:: IgnoreMacros
 
-   If this option is set to `true` (default is `true`), the check will not warn
-   about members declared inside macros.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-equals-default.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-equals-default.rst
@@ -32,6 +32,7 @@ Options
 
 .. option:: IgnoreMacros
 
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
    If set to `true`, the check will not give warnings inside macros and will
    ignore special members with bodies contain macros or preprocessor directives.
    Default is `true`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-equals-delete.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-equals-delete.rst
@@ -41,5 +41,4 @@ for manually relocating functions to the ``public`` section.
 
 .. option:: IgnoreMacros
 
-   If this option is set to `true` (default is `true`), the check will not warn
-   about functions declared inside macros.
+  See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-ranges.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-ranges.rst
@@ -127,8 +127,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: UseReversePipe
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-std-numbers.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-std-numbers.rst
@@ -70,5 +70,4 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/modernize/use-using.rst b/clang-tools-extra/docs/clang-tidy/checks/modernize/use-using.rst
@@ -43,8 +43,7 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+  See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreExternC
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst b/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst
@@ -59,8 +59,7 @@ Options
 
 .. option:: IncludeStyle
 
-   A string specifying which include-style is used, `llvm` or `google`. Default
-   is `llvm`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: AllowedTypes
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/avoid-const-params-in-decls.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/avoid-const-params-in-decls.rst
@@ -21,5 +21,4 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+  See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/const-return-type.rst
@@ -31,5 +31,4 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/function-cognitive-complexity.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/function-cognitive-complexity.rst
@@ -26,8 +26,9 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will ignore code inside macros. Note, that also
-   any macro arguments are ignored, even if they should count to the complexity.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
+   Note, that also any macro arguments are ignored, even if they should count
+   to the complexity.
    As this might change in the future, this option isn't guaranteed to be
    forward-compatible. Default is `false`.
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/inconsistent-declaration-parameter-name.rst
@@ -54,8 +54,7 @@ the definition or the first declaration seen in a translation unit.
 
 .. option:: IgnoreMacros
 
-   If this option is set to `true` (default is `true`), the check will not warn
-   about names declared inside macros.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: Strict
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/redundant-casting.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/redundant-casting.rst
@@ -27,8 +27,7 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: IgnoreTypeAliases
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/redundant-declaration.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/redundant-declaration.rst
@@ -33,5 +33,4 @@ Options
 
 .. option:: IgnoreMacros
 
-   If set to `true`, the check will not give warnings inside macros. Default
-   is `true`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/redundant-smartptr-get.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/redundant-smartptr-get.rst
@@ -17,5 +17,5 @@ Examples:
 
 .. option:: IgnoreMacros
 
-   If this option is set to `true` (default is `true`), the check will not warn
-   about calls inside macros.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
+
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/simplify-boolean-expr.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/simplify-boolean-expr.rst
@@ -84,8 +84,7 @@ Options
 
 .. option:: IgnoreMacros
 
-   If `true`, ignore boolean expressions originating from expanded macros.
-   Default is `false`.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
 
 .. option:: ChainedConditionalReturn
 
diff --git a/clang-tools-extra/docs/clang-tidy/checks/readability/uppercase-literal-suffix.rst b/clang-tools-extra/docs/clang-tidy/checks/readability/uppercase-literal-suffix.rst
@@ -52,5 +52,4 @@ Given a list `L;uL`:
 
 .. option:: IgnoreMacros
 
-   If this option is set to `true` (default is `true`), the check will not warn
-   about literal suffixes inside macros.
+   See :doc:`global options <clang-tidy/GlobalOptions>`.
diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst
@@ -10,6 +10,7 @@ See also:
    :maxdepth: 1
 
    The list of clang-tidy checks <checks/list>
+   The list of clang-tidy global configuration <GlobalOptions>
    Clang-tidy IDE/Editor Integrations <Integrations>
    Getting Involved <Contributing>
    External Clang-Tidy Examples <ExternalClang-TidyExamples>
