Author: aaronballman Date: Mon Jul 27 08:41:30 2015 New Revision: 243266 URL: http://llvm.org/viewvc/llvm-project?rev=243266&view=rev Log: Updating the documentation for clang-tidy. Removes some non-ASCII characters from the documentation, and removes shell-specific single quote characters as they cause issues for some shells (such as on Windows).
Modified: clang-tools-extra/trunk/clang-tidy/tool/ClangTidyMain.cpp clang-tools-extra/trunk/docs/clang-tidy.rst Modified: clang-tools-extra/trunk/clang-tidy/tool/ClangTidyMain.cpp URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/clang-tidy/tool/ClangTidyMain.cpp?rev=243266&r1=243265&r2=243266&view=diff ============================================================================== --- clang-tools-extra/trunk/clang-tidy/tool/ClangTidyMain.cpp (original) +++ clang-tools-extra/trunk/clang-tidy/tool/ClangTidyMain.cpp Mon Jul 27 08:41:30 2015 @@ -106,7 +106,7 @@ static cl::opt<bool> static cl::opt<bool> ListChecks("list-checks", cl::desc("List all enabled checks and exit. Use with\n" - "-checks='*' to list all available checks."), + "-checks=* to list all available checks."), cl::init(false), cl::cat(ClangTidyCategory)); static cl::opt<std::string> Config( @@ -171,7 +171,7 @@ static void printStats(const ClangTidySt << " with check filters"; llvm::errs() << ").\n"; if (Stats.ErrorsIgnoredNonUserCode) - llvm::errs() << "Use -header-filter='.*' to display errors from all " + llvm::errs() << "Use -header-filter=.* to display errors from all " "non-system headers.\n"; } } Modified: clang-tools-extra/trunk/docs/clang-tidy.rst URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy.rst?rev=243266&r1=243265&r2=243266&view=diff ============================================================================== --- clang-tools-extra/trunk/docs/clang-tidy.rst (original) +++ clang-tools-extra/trunk/docs/clang-tidy.rst Mon Jul 27 08:41:30 2015 @@ -29,13 +29,13 @@ negative globs remove them. For example, .. code-block:: console - $ clang-tidy test.cpp -checks='-*,clang-analyzer-*,-clang-analyzer-alpha*' + $ clang-tidy test.cpp -checks=-*,clang-analyzer-*,-clang-analyzer-alpha* will disable all default checks (``-*``) and enable all ``clang-analyzer-*`` checks except for ``clang-analyzer-alpha*`` ones. The ``-list-checks`` option lists all the enabled checks. When used without -``-checks=``, it shows checks enabled by default. Use ``-checks='*'`` to see all +``-checks=``, it shows checks enabled by default. Use ``-checks=*`` to see all available checks or with any other value of ``-checks=`` to see which checks are enabled by this value. @@ -135,7 +135,7 @@ An overview of all the command-line opti {"name":"file2.h"} ] -list-checks - List all enabled checks and exit. Use with - -checks='*' to list all available checks. + -checks=* to list all available checks. -p=<string> - Build path -system-headers - Display the errors from system headers. @@ -243,26 +243,26 @@ The Directory Structure :: clang-tidy/ # Clang-tidy core. - âââ ClangTidy.h # Interfaces for users and checks. - âââ ClangTidyModule.h # Interface for clang-tidy modules. - âââ ClangTidyModuleRegistry.h # Interface for registering of modules. + |-- ClangTidy.h # Interfaces for users and checks. + |-- ClangTidyModule.h # Interface for clang-tidy modules. + |-- ClangTidyModuleRegistry.h # Interface for registering of modules. ... - âââ google/ # Google clang-tidy module. - â  âââ GoogleTidyModule.cpp - â  âââ GoogleTidyModule.h + |-- google/ # Google clang-tidy module. + |-- |-- GoogleTidyModule.cpp + |-- |-- GoogleTidyModule.h ... - âââ llvm/ # LLVM clang-tidy module. - â  âââ LLVMTidyModule.cpp - â  âââ LLVMTidyModule.h + |-- llvm/ # LLVM clang-tidy module. + |-- |-- LLVMTidyModule.cpp + |-- |-- LLVMTidyModule.h ... - âââ tool/ # Sources of the clang-tidy binary. + |-- tool/ # Sources of the clang-tidy binary. ... test/clang-tidy/ # Integration tests. ... unittests/clang-tidy/ # Unit tests. - âââ ClangTidyTest.h - âââ GoogleModuleTest.cpp - âââ LLVMModuleTest.cpp + |-- ClangTidyTest.h + |-- GoogleModuleTest.cpp + |-- LLVMModuleTest.cpp ... @@ -487,7 +487,7 @@ The script provides multiple configurati * The default set of checks can be overridden using the ``-checks`` argument, taking the identical format as :program:`clang-tidy` does. For example - ``-checks='-*,misc-use-override'`` will run the ``misc-use-override`` + ``-checks=-*,misc-use-override`` will run the ``misc-use-override`` checker only. * To restrict the files examined you can provide one or more regex arguments _______________________________________________ cfe-commits mailing list cfe-commits@cs.uiuc.edu http://lists.cs.uiuc.edu/mailman/listinfo/cfe-commits