deploy: 5b60ab8

Author: 2bndy5

.doctrees/cli_args.doctree

@@ -1,16 +1,37 @@
-Command Line Interface Options
-==============================
 
-.. std:option:: -v, --verbosity
+Command Line Interface
+======================
 
-    This controls the action's verbosity in the workflow's logs.
-    Supported options are defined by the `logging-level <logging-levels>`_.
-    This option does not affect the verbosity of resulting
-    thread comments or file annotations.
+Commands
+--------
+
+.. std:option:: version
+
+    Display the cpp-linter version and exit.
+
+
+Clang-tidy options
+------------------
+
+.. std:option:: -c, --tidy-checks
+
+    A comma-separated list of globs with optional ``-`` prefix.
+    Globs are processed in order of appearance in the list.
+    Globs without ``-`` prefix add checks with matching names to the set,
+    globs with the ``-`` prefix remove checks with matching names from the set of
+    enabled checks. This option's value is appended to the value of the 'Checks'
+    option in a .clang-tidy file (if any).
+    
+    - It is possible to disable clang-tidy entirely by setting this option to
+      ``'-*'``.
+    - It is also possible to rely solely on a .clang-tidy config file by
+      specifying this option as a blank string (``''``).
+    
+    See also clang-tidy docs for more info.
 
 
     :Default:
-        ``"info"``
+        ``"boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*"``
 .. std:option:: -p, --database
 
     The path that is used to read a compile command database.
@@ -21,6 +42,27 @@ Command Line Interface Options
     https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html for an
     example of setting up Clang Tooling on a source tree.
 
+.. std:option:: -x, --extra-arg
+
+    A string of extra arguments passed to clang-tidy for use as
+    compiler arguments. This can be specified more than once for each
+    additional argument. Recommend using quotes around the value and
+    avoid using spaces between name and value (use ``=`` instead):
+    
+    .. code-block:: shell
+    
+        cpp-linter --extra-arg="-std=c++17" --extra-arg="-Wall"
+
+.. std:option:: -D, --ignore-tidy
+
+    Similar to `--ignore` but applied exclusively to files analyzed by clang-tidy.
+
+    :Default:
+        ``""``
+
+Clang-format options
+--------------------
+
 .. std:option:: -s, --style
 
     The style rules to use.
@@ -33,25 +75,26 @@ Command Line Interface Options
 
     :Default:
         ``"llvm"``
-.. std:option:: -c, --tidy-checks
+.. std:option:: -M, --ignore-format
 
-    A comma-separated list of globs with optional ``-`` prefix.
-    Globs are processed in order of appearance in the list.
-    Globs without ``-`` prefix add checks with matching names to the set,
-    globs with the ``-`` prefix remove checks with matching names from the set of
-    enabled checks. This option's value is appended to the value of the 'Checks'
-    option in a .clang-tidy file (if any).
-    
-    - It is possible to disable clang-tidy entirely by setting this option to
-      ``'-*'``.
-    - It is also possible to rely solely on a .clang-tidy config file by
-      specifying this option as a blank string (``''``).
-    
-    See also clang-tidy docs for more info.
+    Similar to `--ignore` but applied exclusively to files analyzed by clang-format.
+
+    :Default:
+        ``""``
+
+General options
+---------------
+
+.. std:option:: -v, --verbosity
+
+    This controls the action's verbosity in the workflow's logs.
+    Supported options are defined by the `logging-level <logging-levels>`_.
+    This option does not affect the verbosity of resulting
+    thread comments or file annotations.
 
 
     :Default:
-        ``"boost-*,bugprone-*,performance-*,readability-*,portability-*,modernize-*,clang-analyzer-*,cppcoreguidelines-*"``
+        ``"info"``
 .. std:option:: -V, --version
 
     The desired version of the clang tools to use. Accepted options are
@@ -66,6 +109,10 @@ Command Line Interface Options
 
     :Default:
         ``""``
+
+Source options
+--------------
+
 .. std:option:: -e, --extensions
 
     A comma-separated list of file extensions to analyze.
@@ -131,16 +178,9 @@ Command Line Interface Options
 
     :Default:
         ``"false"``
-.. std:option:: -x, --extra-arg
 
-    A string of extra arguments passed to clang-tidy for use as
-    compiler arguments. This can be specified more than once for each
-    additional argument. Recommend using quotes around the value and
-    avoid using spaces between name and value (use ``=`` instead):
-    
-    .. code-block:: shell
-    
-        cpp-linter --extra-arg="-std=c++17" --extra-arg="-Wall"
+Feedback options
+----------------
 
 .. std:option:: -g, --thread-comments