Skip to content

Commit c139a1c

Browse files
committedAug 17, 2016
[Documentation] Remove duplicated checks groups descriptions from clang-tidy/index.rst.
Differential revision: https://reviews.llvm.org/D23596 llvm-svn: 279006
1 parent 99e765b commit c139a1c

File tree

1 file changed

+9
-23
lines changed

1 file changed

+9
-23
lines changed
 

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

Lines changed: 9 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,8 @@ The ``-list-checks`` option lists all the enabled checks. When used without
4848
available checks or with any other value of ``-checks=`` to see which checks are
4949
enabled by this value.
5050

51+
:: _checks-groups-table:
52+
5153
There are currently the following groups of checks:
5254

5355
====================== =========================================================
@@ -338,29 +340,13 @@ style used in the project. For code reviews we mostly use `LLVM Phabricator`_.
338340
.. _LLVM Coding Standards: http://llvm.org/docs/CodingStandards.html
339341
.. _LLVM Phabricator: http://llvm.org/docs/Phabricator.html
340342

341-
342-
Next, you need to decide which module the check belongs to. If the check
343-
verifies conformance of the code to a certain coding style, it probably deserves
344-
a separate module and a directory in ``clang-tidy/``. There are already modules
345-
implementing checks related to:
346-
347-
* `C++ Core Guidelines
348-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/cppcoreguidelines/>`_
349-
* `CERT Secure Coding Standards
350-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/cert/>`_
351-
* `Google Style Guide
352-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/google/>`_
353-
* `LLVM Style
354-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/llvm/>`_
355-
* `modernizing C/C++ code
356-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/modernize/>`_
357-
* potential `performance problems
358-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/performance/>`_
359-
* various `readability issues
360-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/readability/>`_
361-
* and `miscellaneous checks
362-
<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/misc/>`_
363-
that we couldn't find a better category for.
343+
Next, you need to decide which module the check belongs to. Modules
344+
are located in subdirectories of
345+
``clang-tidy/ <http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/>``_
346+
and contain checks targeting a certain aspect of code quality (performance,
347+
readability, etc.), certain coding style or standard (Google, LLVM, CERT, etc.)
348+
or a widely used API (e.g. MPI). Their names are same as user-facing check
349+
groups names described :ref:`above <checks-groups-table>`.
364350
365351
After choosing the module, you need to create a class for your check:
366352

0 commit comments

Comments
 (0)
Please sign in to comment.