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

[Phabricator via cfe-commits]

This revision was automatically updated to reflect the committed changes.
Closed by commit rL279006: [Documentation] Remove duplicated checks groups 
descriptions from clang… (authored by eugenezelenko).

Changed prior to commit:
  https://reviews.llvm.org/D23596?vs=68447&id=68449#toc

Repository:
  rL LLVM

https://reviews.llvm.org/D23596

Files:
  clang-tools-extra/trunk/docs/clang-tidy/index.rst

Index: clang-tools-extra/trunk/docs/clang-tidy/index.rst
===
--- clang-tools-extra/trunk/docs/clang-tidy/index.rst
+++ clang-tools-extra/trunk/docs/clang-tidy/index.rst
@@ -48,6 +48,8 @@
 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 @@
 .. _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:
 


Index: clang-tools-extra/trunk/docs/clang-tidy/index.rst
===
--- clang-tools-extra/trunk/docs/clang-tidy/index.rst
+++ clang-tools-extra/trunk/docs/clang-tidy/index.rst
@@ -48,6 +48,8 @@
 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 @@
 .. _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
+ar

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

[Alexander Kornienko via cfe-commits]

alexfh accepted this revision.
alexfh added a comment.
This revision is now accepted and ready to land.

LG. Thanks!


Repository:
  rL LLVM

https://reviews.llvm.org/D23596



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Eugene Zelenko via cfe-commits]

Eugene.Zelenko marked an inline comment as done.
Eugene.Zelenko added a comment.

Repository:
  rL LLVM

https://reviews.llvm.org/D23596



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Eugene Zelenko via cfe-commits]

Eugene.Zelenko updated this revision to Diff 68447.
Eugene.Zelenko added a comment.

Address Alexander's comments.


Repository:
  rL LLVM

https://reviews.llvm.org/D23596

Files:
  docs/clang-tidy/index.rst

Index: docs/clang-tidy/index.rst
===
--- docs/clang-tidy/index.rst
+++ docs/clang-tidy/index.rst
@@ -48,6 +48,8 @@
 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,30 +340,14 @@
 .. _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. 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 `.
 
-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.
-
 After choosing the module, you need to create a class for your check:
 
 .. code-block:: c++


Index: docs/clang-tidy/index.rst
===
--- docs/clang-tidy/index.rst
+++ docs/clang-tidy/index.rst
@@ -48,6 +48,8 @@
 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,30 +340,14 @@
 .. _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. 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 `.
 
-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
-  

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

[Eugene Zelenko via cfe-commits]

Eugene.Zelenko marked 3 inline comments as done.
Eugene.Zelenko added a comment.

Repository:
  rL LLVM

https://reviews.llvm.org/D23596



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Alexander Kornienko via cfe-commits]

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/ 
``_.
+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/ 
``_.
+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



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Eugene Zelenko via cfe-commits]

Eugene.Zelenko added a reviewer: aaron.ballman.
Eugene.Zelenko updated this revision to Diff 68390.
Eugene.Zelenko added a comment.

Rephrase text and add link to Clang-tidy directory. Will be good idea is native 
English speaker will look on this change.


Repository:
  rL LLVM

https://reviews.llvm.org/D23596

Files:
  docs/clang-tidy/index.rst

Index: docs/clang-tidy/index.rst
===
--- docs/clang-tidy/index.rst
+++ docs/clang-tidy/index.rst
@@ -338,30 +338,13 @@
 .. _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. Modules
+are located in subdirectories of
+``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
+probably deserves a separate module and a directory in ``clang-tidy/``.
 
-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.
-
 After choosing the module, you need to create a class for your check:
 
 .. code-block:: c++


Index: docs/clang-tidy/index.rst
===
--- docs/clang-tidy/index.rst
+++ docs/clang-tidy/index.rst
@@ -338,30 +338,13 @@
 .. _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. Modules
+are located in subdirectories of
+``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
+probably deserves a separate module and a directory in ``clang-tidy/``.
 
-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.
-
 After choosing the module, you need to create a class for your check:
 
 .. code-block:: c++
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Alexander Kornienko via cfe-commits]

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


Comment at: docs/clang-tidy/index.rst:344
@@ -343,4 +343,3 @@
 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:
+a separate module and a directory in ``clang-tidy/``.
 

These links point to the code, so they are still somewhat useful. We could 
leave a link to the clang-tidy directory 
(http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/)
 and explain that most subdirectories there correspond to check modules and the 
descriptions of modules can be found .


Repository:
  rL LLVM

https://reviews.llvm.org/D23596



___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits

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

[Eugene Zelenko via cfe-commits]

Eugene.Zelenko created this revision.
Eugene.Zelenko added a reviewer: alexfh.
Eugene.Zelenko added a subscriber: cfe-commits.
Eugene.Zelenko set the repository for this revision to rL LLVM.

Checks are described at beginning and directory names follow name prefixes, so 
another list is redundant.

Repository:
  rL LLVM

https://reviews.llvm.org/D23596

Files:
  docs/clang-tidy/index.rst

Index: docs/clang-tidy/index.rst
===
--- docs/clang-tidy/index.rst
+++ docs/clang-tidy/index.rst
@@ -341,27 +341,8 @@
 
 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:
+a separate module and a directory in ``clang-tidy/``.
 
-* `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.
-
 After choosing the module, you need to create a class for your check:
 
 .. code-block:: c++


Index: docs/clang-tidy/index.rst
===
--- docs/clang-tidy/index.rst
+++ docs/clang-tidy/index.rst
@@ -341,27 +341,8 @@
 
 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:
+a separate module and a directory in ``clang-tidy/``.
 
-* `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.
-
 After choosing the module, you need to create a class for your check:
 
 .. code-block:: c++
___
cfe-commits mailing list
cfe-commits@lists.llvm.org
http://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits