Skip to content

Commit e5997ac

Browse files
committed
fix help
1 parent 5739d03 commit e5997ac

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

clang-tools-extra/clang-tidy/tool/ClangTidyMain.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,11 @@ static cl::desc desc(StringRef description) { return {description.ltrim()}; }
3838
static cl::OptionCategory ClangTidyCategory("clang-tidy options");
3939

4040
static cl::extrahelp CommonHelp(CommonOptionsParser::HelpMessage);
41+
static cl::extrahelp ClangTidyParameterFileHelp(R"(
42+
Parameters files:
43+
A large number of options or source files can be passed as parameter files
44+
by use '@parameter-file' in the command line.
45+
)");
4146
static cl::extrahelp ClangTidyHelp(R"(
4247
Configuration files:
4348
clang-tidy attempts to read configuration for each source file from a

clang-tools-extra/docs/clang-tidy/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ compilation options on the command line after ``--``:
3333
3434
$ clang-tidy test.cpp -- -Imy_project/include -DMY_DEFINES ...
3535
36-
If there are too many options to specify on the command line, you can store them
37-
in a parameter file, and use :program:`clang-tidy` with parameters file:
36+
If there are too many options or source files to specify on the command line,
37+
you can store them in a parameter file, and use :program:`clang-tidy` with that
38+
parameters file:
3839

3940
.. code-block:: console
4041
@@ -271,6 +272,9 @@ An overview of all the command-line options:
271272
automatically removed, but the rest of a relative path must be a
272273
suffix of a path in the compile command database.
273274
275+
Parameters files:
276+
A large number of options or source files can be passed as parameter files
277+
by use '@parameter-file' in the command line.
274278
275279
Configuration files:
276280
clang-tidy attempts to read configuration for each source file from a

0 commit comments

Comments
 (0)