[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
PiotrZSL added inline comments. Comment at: clang-tools-extra/docs/clang-tidy/index.rst:272 + parent one. +SystemHeaders- Same as '--system-headers'. +UseColor - Same as '--use-color'. This is a bug, SystemHeaders cannot be specified on this level, as they not added to `MappingTraits`. Therefor listing them here is a misleading. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
This revision was automatically updated to reflect the committed changes.
Closed by commit rG2706919f9197: [clang-tidy][doc] Improve clang-tidy
documentation (authored by carlosgalvezp).
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
- e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+--config-file= - Specify the path of .clang-tidy or custom config file:
+ e.g. --config-file=/some/path/myTidyConfigFile
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--ext
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp marked an inline comment as done. carlosgalvezp added a comment. All comments have been addressed, I intend to land the patch by February 9th unless more feedback is received. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp marked an inline comment as done.
carlosgalvezp added inline comments.
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:34
+static StringRef TrimFirstChar(StringRef x) { return x.substr(1); }
+
ClockMan wrote:
> Looks like usecase of this is more like rtrim, then probably rtrim should be
> used instead of substr.
> And probably better would be to replace entire cl::desc. instead of adding
> new additional wrap.
>
> more like:
> static auto desc(llvm::StringRef description) { return
> cl::desc(description.rtrim()); }
Really good idea, much better! Done.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 493110.
carlosgalvezp added a comment.
Wrap trimming functionality in desc function.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
- e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+--config-file= - Specify the path of .clang-tidy or custom config file:
+ e.g. --config-file=/some/path/myTidyConfigFile
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
ClockMan added inline comments.
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:34
+static StringRef TrimFirstChar(StringRef x) { return x.substr(1); }
+
Looks like usecase of this is more like rtrim, then probably rtrim should be
used instead of substr.
And probably better would be to replace entire cl::desc. instead of adding new
additional wrap.
more like:
static auto desc(llvm::StringRef description) { return
cl::desc(description.rtrim()); }
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp added a comment. Friendly ping @njames93 , see my previous comment about `TrimFirstChar`. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 491731.
carlosgalvezp edited the summary of this revision.
carlosgalvezp added a comment.
Remove newline
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 491729.
carlosgalvezp added a comment.
Fix formatting
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -110,6 +110,7 @@
.. code-block:: console
$ clang-tidy --help
+
USAGE: clang-tidy [options] [... ]
OPTIONS:
@@ -122,8 +123,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +132,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +151,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepen
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 491728.
carlosgalvezp added a comment.
Add HeaderFileExtensions and ImplementationFileExtensions
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -110,6 +110,7 @@
.. code-block:: console
$ clang-tidy --help
+
USAGE: clang-tidy [options] [... ]
OPTIONS:
@@ -122,170 +123,171 @@
clang-tidy options:
---checks= -
- 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 .clang-tidy
- file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
- -config="{Checks: '*',
- CheckOptions: {x, y}}"
- When the value is empty, clang-tidy will
- attempt to find a file named .clang-tidy for
- each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--checks= - 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 .clang-tidy
+file, if any.
+--config= - Specifies a configuration in YAML/JSON format:
+ -config="{Checks: '*',
+CheckOptions: {x: y}}"
+When the value is empty, clang-tidy will
+attempt to find a file named .clang-tidy for
+each source file in its parent directories.
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
This option internally works exactly the same way as
--config option after reading specified config file.
Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
- stdout. This option can be used along with a
- file name (and '--' if the file is outside of a
- project with configured compilation database).
- The configuration used for this file will be
- printed.
- Use along with -checks=* to include
- configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
- report to stderr.
---explain-config -
- For each enabled check explains, where it is
- enabled, i.e. in clang-tidy binary, command
- line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
- stored fixes can be appli
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 42.
carlosgalvezp added a comment.
Add ExtraArgs and ExtraArgsBefore
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply suggested fixes. Without -fix-
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp added inline comments.
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:34
+static StringRef TrimFirstChar(StringRef x) { return x.substr(1); }
+
njames93 wrote:
> This seems a bit of a needless change, if you want to remove the newline,
> just in date the raw string literal and remove the empty line
I'm not sure I understand what you mean by "just in date the raw string", could
you clarify?
In Diff 7 I fixed this without `TrimFirstChar`, but it leads to fairly
inconsistent code, where the first `R"(` needs to be part of the first line of
text:
```
R"(some text
some more text
)"
```
versus:
```
R"(
some text
some more text
)"
```
Let me know which option you prefer.
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:82
CheckOptions:
- some-check.SomeOption: 'some value'
+ - key:some-check.SomeOption
+value: 'some value'
njames93 wrote:
> This change can be reverted.
Thanks, I didn't know it was another valid way to write it! Will fix
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 487844.
carlosgalvezp marked 3 inline comments as done.
carlosgalvezp added a comment.
Revert changes to CheckOptions
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
njames93 added inline comments.
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:34
+static StringRef TrimFirstChar(StringRef x) { return x.substr(1); }
+
This seems a bit of a needless change, if you want to remove the newline, just
in date the raw string literal and remove the empty line
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:53
+- key: check-a.SomeOption
+ value: value-a
+- key: check-b.OtherOption
Can this be changed to match the previous format defined below
Comment at: clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp:82
CheckOptions:
- some-check.SomeOption: 'some value'
+ - key:some-check.SomeOption
+value: 'some value'
This change can be reverted.
Comment at: clang-tools-extra/docs/clang-tidy/index.rst:261
+CheckOptions:
+ - key: check-a.SomeOption
+value: value-a
Again as before
Comment at: clang-tools-extra/docs/clang-tidy/index.rst:292
+- key:some-check.SomeOption
+ value: 'some value'
...
Ditto
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp added a comment. @njames93 Do you agree with the overall idea of documenting config file options like this? I need this in place for the other patch that cleans the duplication for `HeaderFileExtensions`, `ImplementationFileExtensions`, `IncludeStyle`, etc. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 487370.
carlosgalvezp added a comment.
Trim first character instead, to keep the code visually
pleasing.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Appl
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 487363.
carlosgalvezp marked an inline comment as done.
carlosgalvezp added a comment.
Fix formatting
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply s
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
Eugene.Zelenko accepted this revision. Eugene.Zelenko added a comment. This revision is now accepted and ready to land. But will be good idea to wait for other reviewers. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp marked 2 inline comments as done. carlosgalvezp added inline comments. Comment at: clang-tools-extra/docs/clang-tidy/index.rst:142 e.g. --config-file=/some/path/myTidyConfigFile -This option internally works exactly the same way as + This option internally works exactly the same way as --config option after reading specified config file. Eugene.Zelenko wrote: > Is this merge artifact? Same below. I honestly have no idea, it seems some artifact of Phabricator that is unrelated to the code which is just fine. It's not a tab either, checked with my editor. I have seen it in patches from other people as well, leading to confusion... Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
Eugene.Zelenko accepted this revision. Eugene.Zelenko added inline comments. This revision is now accepted and ready to land. Comment at: clang-tools-extra/docs/clang-tidy/index.rst:142 e.g. --config-file=/some/path/myTidyConfigFile -This option internally works exactly the same way as + This option internally works exactly the same way as --config option after reading specified config file. Is this merge artifact? Same below. Comment at: clang-tools-extra/docs/clang-tidy/index.rst:215 +--use-color- Use colors in diagnostics. If not set, colors + will be used if the terminal connected to + standard output supports colors. Ditto. Repository: rG LLVM Github Monorepo CHANGES SINCE LAST ACTION https://reviews.llvm.org/D141144/new/ https://reviews.llvm.org/D141144 ___ cfe-commits mailing list cfe-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 486922.
carlosgalvezp added a comment.
Fix alignment
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply suggested fixes. Without -fix-errors
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 486921.
carlosgalvezp added a comment.
Remove colon after the config options, for consistency with
the command-line options.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 486916.
carlosgalvezp added a comment.
Fix incorrect dash in key/value pairs
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply suggested fixes. Without -
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 486915.
carlosgalvezp added a comment.
Remove wrong dash in key/value options.
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply suggested fixes. Without
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp updated this revision to Diff 486913.
carlosgalvezp added a comment.
Remove extra newline
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D141144/new/
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-apply-replacements.
---extra-arg= - Additional argument to append to the compiler command line.
- Can be used several times.
---extra-arg-before=- Additional argument to prepend to the compiler command line.
- Can be used several times.
---fix -
- Apply suggested fixes. Without -fix-errors
+--extra-arg= - Additional argument to append to the compiler command line
+--extra-arg-before=- Additional argument to prepend to the compiler command line
+--fix - Apply suggested fixes. Without -fix-errors
[PATCH] D141144: [clang-tidy][doc] Improve clang-tidy documentation
carlosgalvezp created this revision.
Herald added subscribers: arphaman, xazax.hun.
Herald added a reviewer: njames93.
Herald added a project: All.
carlosgalvezp requested review of this revision.
Herald added a project: clang-tools-extra.
Herald added a subscriber: cfe-commits.
- Specify that the .clang-tidy file is in YAML format.
- Document the options that may be used in the .clang-tidy file,
- Add missing documentation for existing options (User).
- Fix output example of --dump-config (incorrect format of CheckOptions).
- Fix spurious newline after the dash that comes after every command-line
option. This was inconsistent with single-line descriptions, which lacked a
newline. The description is now aligned with the dash and the corresponding
command-line option, more visually pleasing.
This will enable documenting upcoming global clang-tidy
configuration options.
Repository:
rG LLVM Github Monorepo
https://reviews.llvm.org/D141144
Files:
clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp
clang-tools-extra/docs/clang-tidy/index.rst
Index: clang-tools-extra/docs/clang-tidy/index.rst
===
--- clang-tools-extra/docs/clang-tidy/index.rst
+++ clang-tools-extra/docs/clang-tidy/index.rst
@@ -122,8 +122,7 @@
clang-tidy options:
---checks= -
- Comma-separated list of globs with optional '-'
+--checks= - 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
@@ -132,21 +131,18 @@
checks. This option's value is appended to the
value of the 'Checks' option in .clang-tidy
file, if any.
---config= -
- Specifies a configuration in YAML/JSON format:
+--config= - Specifies a configuration in YAML/JSON format:
-config="{Checks: '*',
- CheckOptions: {x, y}}"
+ CheckOptions: {x: y}}"
When the value is empty, clang-tidy will
attempt to find a file named .clang-tidy for
each source file in its parent directories.
---config-file= -
-Specify the path of .clang-tidy or custom config file:
+--config-file= - Specify the path of .clang-tidy or custom config file:
e.g. --config-file=/some/path/myTidyConfigFile
-This option internally works exactly the same way as
+ This option internally works exactly the same way as
--config option after reading specified config file.
-Use either --config-file or --config, not both.
---dump-config -
- Dumps configuration in the YAML format to
+ Use either --config-file or --config, not both.
+--dump-config - Dumps configuration in the YAML format to
stdout. This option can be used along with a
file name (and '--' if the file is outside of a
project with configured compilation database).
@@ -154,38 +150,29 @@
printed.
Use along with -checks=* to include
configuration of all checks.
---enable-check-profile -
- Enable per-check timing profiles, and print a
+--enable-check-profile - Enable per-check timing profiles, and print a
report to stderr.
---explain-config -
- For each enabled check explains, where it is
+--explain-config - For each enabled check explains, where it is
enabled, i.e. in clang-tidy binary, command
line or a specific configuration file.
---export-fixes= -
- YAML file to store suggested fixes in. The
+--export-fixes= - YAML file to store suggested fixes in. The
stored fixes can be applied to the input source
code with clang-ap
