[PATCH] D23596: [Documentation] Remove duplicated checks groups descriptions form clang-tidy/index.rst

Alexander Kornienko via cfe-commits cfe-commits at lists.llvm.org
Wed Aug 17 15:26:14 PDT 2016


alexfh requested changes to this revision.
This revision now requires changes to proceed.

================
Comment at: docs/clang-tidy/index.rst:343
@@ +342,3 @@
+are located in subdirectories of
+``clang-tidy/ <http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/>``_.
+Their names are same as user-facing check groups names described above.
----------------
`are located in subdirectories of .... 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).`

================
Comment at: docs/clang-tidy/index.rst:344
@@ +343,3 @@
+``clang-tidy/ <http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/>``_.
+Their names are same as user-facing check groups names described above.
+If the check verifies conformance of the code to a certain coding style, it
----------------
Could you linkify `above`?

================
Comment at: docs/clang-tidy/index.rst:345
@@ +344,3 @@
+Their names are same as user-facing check groups names described above.
+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/``.
----------------
The "If the check verifies..." sentence is now somewhat tautological, just remove it.


Repository:
  rL LLVM

https://reviews.llvm.org/D23596





More information about the cfe-commits mailing list