diff options
author | Alexander Kornienko <alexfh@google.com> | 2014-05-16 13:07:18 +0000 |
---|---|---|
committer | Alexander Kornienko <alexfh@google.com> | 2014-05-16 13:07:18 +0000 |
commit | eabdebe2d9a5cc61a4c314946a78229449e6a793 (patch) | |
tree | 1e878a3d0382dd0f6d2627b37d4d40a6fb4b67a5 /clang-tidy/tool/ClangTidyMain.cpp | |
parent | 491415934d681201dc43138e92cb4c1b1344f222 (diff) |
Update clang-tidy documentation.
Summary:
Updated the help message, updated description of -checks=, removed
mentions of -disable-checks.
Reviewers: klimek
Reviewed By: klimek
Subscribers: cfe-commits
Differential Revision: http://reviews.llvm.org/D3793
git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/trunk@208979 91177308-0d34-0410-b5e6-96231b3b80d8
Diffstat (limited to 'clang-tidy/tool/ClangTidyMain.cpp')
-rw-r--r-- | clang-tidy/tool/ClangTidyMain.cpp | 43 |
1 files changed, 24 insertions, 19 deletions
diff --git a/clang-tidy/tool/ClangTidyMain.cpp b/clang-tidy/tool/ClangTidyMain.cpp index 4e815c0d..86def378 100644 --- a/clang-tidy/tool/ClangTidyMain.cpp +++ b/clang-tidy/tool/ClangTidyMain.cpp @@ -34,29 +34,34 @@ const char DefaultChecks[] = "-llvm-namespace-comment," // Not complete. "-google-*,"; // Doesn't apply to LLVM. static cl::opt<std::string> -Checks("checks", - cl::desc("Comma-separated list of positive and negative globs matching\n" - "the names of the checks to be run."), +Checks("checks", cl::desc("Comma-separated list of globs with optional '-'\n" + "prefix. Globs are processed in order of appearance\n" + "in the list. Globs without '-' prefix add checks\n" + "with matching names to the set, globs with the '-'\n" + "prefix remove checks with matching names from the\n" + "set of enabled checks."), cl::init(""), cl::cat(ClangTidyCategory)); -static cl::opt<std::string> HeaderFilter( - "header-filter", - cl::desc("Regular expression matching the names of the headers to output\n" - "diagnostics from. Diagnostics from the main file of each\n" - "translation unit are always displayed."), - cl::init(""), cl::cat(ClangTidyCategory)); +static cl::opt<std::string> +HeaderFilter("header-filter", + cl::desc("Regular expression matching the names of the\n" + "headers to output diagnostics from.\n" + "Diagnostics from the main file of each\n" + "translation unit are always displayed."), + cl::init(""), cl::cat(ClangTidyCategory)); static cl::opt<bool> Fix("fix", cl::desc("Fix detected errors if possible."), cl::init(false), cl::cat(ClangTidyCategory)); -static cl::opt<bool> ListChecks("list-checks", - cl::desc("List all enabled checks and exit."), - cl::init(false), cl::cat(ClangTidyCategory)); - -static cl::opt<bool> AnalyzeTemporaryDtors( - "analyze-temporary-dtors", - cl::desc("Enable temporary destructor-aware analysis in clang-analyzer- " - "checks."), - cl::init(false), - cl::cat(ClangTidyCategory)); +static cl::opt<bool> +ListChecks("list-checks", + cl::desc("List all enabled checks and exit. Use with\n" + "-checks='*' to list all available checks."), + cl::init(false), cl::cat(ClangTidyCategory)); + +static cl::opt<bool> +AnalyzeTemporaryDtors("analyze-temporary-dtors", + cl::desc("Enable temporary destructor-aware analysis in\n" + "clang-analyzer- checks."), + cl::init(false), cl::cat(ClangTidyCategory)); static void printStats(const clang::tidy::ClangTidyStats &Stats) { unsigned ErrorsIgnored = Stats.ErrorsIgnoredNOLINT + |