maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity

[Documentation] Fix another link in docs/clang-tidy/Contributing.rst. 

llvm-svn: 351468
This commit is contained in:
Eugene Zelenko 2019-01-17 20:00:23 +00:00
parent 76c77d9eaf
commit 390b3b34e0
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
clang-tools-extra/docs/clang-tidy/Contributing.rst
View File

@ -422,12 +422,15 @@ To test a check it's best to try it out on a larger code base. LLVM and Clang
are the natural targets as you already have the source code around. The most are the natural targets as you already have the source code around. The most
convenient way to run :program:`clang-tidy` is with a compile command database; convenient way to run :program:`clang-tidy` is with a compile command database;
CMake can automatically generate one, for a description of how to enable it see CMake can automatically generate one, for a description of how to enable it see
`How To Setup Tooling For LLVM`_. Once ``compile_commands.json`` is in place and `How To Setup Clang Tooling For LLVM`_. Once ``compile_commands.json`` is in
a working version of :program:`clang-tidy` is in ``PATH`` the entire code base place and a working version of :program:`clang-tidy` is in ``PATH`` the entire
can be analyzed with ``clang-tidy/tool/run-clang-tidy.py``. The script executes code base can be analyzed with ``clang-tidy/tool/run-clang-tidy.py``. The script
:program:`clang-tidy` with the default set of checks on every translation unit executes :program:`clang-tidy` with the default set of checks on every
in the compile command database and displays the resulting warnings and errors. translation unit in the compile command database and displays the resulting
The script provides multiple configuration flags. warnings and errors. The script provides multiple configuration flags.
.. _How To Setup Clang Tooling For LLVM: https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html
* The default set of checks can be overridden using the ``-checks`` argument, * The default set of checks can be overridden using the ``-checks`` argument,
taking the identical format as :program:`clang-tidy` does. For example taking the identical format as :program:`clang-tidy` does. For example