From c139a1c252f7d4b234bab8182956b1f78aa2952b Mon Sep 17 00:00:00 2001 From: Eugene Zelenko Date: Wed, 17 Aug 2016 23:20:00 +0000 Subject: [PATCH] [Documentation] Remove duplicated checks groups descriptions from clang-tidy/index.rst. Differential revision: https://reviews.llvm.org/D23596 llvm-svn: 279006 --- clang-tools-extra/docs/clang-tidy/index.rst | 32 ++++++++--------------------- 1 file changed, 9 insertions(+), 23 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/index.rst b/clang-tools-extra/docs/clang-tidy/index.rst index 0a97b47..6f57bb9 100644 --- a/clang-tools-extra/docs/clang-tidy/index.rst +++ b/clang-tools-extra/docs/clang-tidy/index.rst @@ -48,6 +48,8 @@ The ``-list-checks`` option lists all the enabled checks. When used without available checks or with any other value of ``-checks=`` to see which checks are enabled by this value. +:: _checks-groups-table: + There are currently the following groups of checks: ====================== ========================================================= @@ -338,29 +340,13 @@ style used in the project. For code reviews we mostly use `LLVM Phabricator`_. .. _LLVM Coding Standards: http://llvm.org/docs/CodingStandards.html .. _LLVM Phabricator: http://llvm.org/docs/Phabricator.html - -Next, you need to decide which module the check belongs to. If the check -verifies conformance of the code to a certain coding style, it probably deserves -a separate module and a directory in ``clang-tidy/``. There are already modules -implementing checks related to: - -* `C++ Core Guidelines - `_ -* `CERT Secure Coding Standards - `_ -* `Google Style Guide - `_ -* `LLVM Style - `_ -* `modernizing C/C++ code - `_ -* potential `performance problems - `_ -* various `readability issues - `_ -* and `miscellaneous checks - `_ - that we couldn't find a better category for. +Next, you need to decide which module the check belongs to. Modules +are located in subdirectories of +``clang-tidy/ ``_ +and contain checks targeting a certain aspect of code quality (performance, +readability, etc.), certain coding style or standard (Google, LLVM, CERT, etc.) +or a widely used API (e.g. MPI). Their names are same as user-facing check +groups names described :ref:`above `. After choosing the module, you need to create a class for your check: -- 2.7.4