This is an archive of the discontinued LLVM Phabricator instance.

docs/clang-tidy/index.rst
344	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 <link to the relevant section of this documentation>.

This revision now requires changes to proceed.Aug 17 2016, 2:59 AM

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

alexfh requested changes to this revision.Aug 17 2016, 3:26 PM

alexfh edited edge metadata.

alexfh added inline comments.

docs/clang-tidy/index.rst
343	`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).`
344	Could you linkify `above`?
345	The "If the check verifies..." sentence is now somewhat tautological, just remove it.

This revision now requires changes to proceed.Aug 17 2016, 3:26 PM

Address Alexander's comments.

LG. Thanks!

This revision is now accepted and ready to land.Aug 17 2016, 4:25 PM

Closed by commit rL279006: [Documentation] Remove duplicated checks groups descriptions from clang… (authored by eugenezelenko). · Explain WhyAug 17 2016, 4:28 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents

Path

Size

docs/

clang-tidy/

index.rst

21 lines

Diff 68295

docs/clang-tidy/index.rst

Context not available.

	Next, you need to decide which module the check belongs to. If the check	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	verifies conformance of the code to a certain coding style, it probably deserves
		alexfhUnsubmitted Done Reply Inline Actions `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).` alexfh: `are located in subdirectories of .... and contain checks targeting a certain aspect of code…
	a separate module and a directory in ``clang-tidy/``. There are already modules	a separate module and a directory in ``clang-tidy/``.
		alexfhUnsubmitted Done Reply Inline Actions 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 <link to the relevant section of this documentation>. alexfh: These links point to the code, so they are still somewhat useful. We could leave a link to the…
		alexfhUnsubmitted Done Reply Inline Actions Could you linkify `above`? alexfh: Could you linkify `above`?
	implementing checks related to:

		alexfhUnsubmitted Done Reply Inline Actions The "If the check verifies..." sentence is now somewhat tautological, just remove it. alexfh: The "If the check verifies..." sentence is now somewhat tautological, just remove it.
	* `C++ Core Guidelines
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/cppcoreguidelines/>`_
	* `CERT Secure Coding Standards
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/cert/>`_
	* `Google Style Guide
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/google/>`_
	* `LLVM Style
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/llvm/>`_
	* `modernizing C/C++ code
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/modernize/>`_
	* potential `performance problems
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/performance/>`_
	* various `readability issues
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/readability/>`_
	* and `miscellaneous checks
	<http://reviews.llvm.org/diffusion/L/browse/clang-tools-extra/trunk/clang-tidy/misc/>`_
	that we couldn't find a better category for.

	After choosing the module, you need to create a class for your check:	After choosing the module, you need to create a class for your check:

	.. code-block:: c++	.. code-block:: c++
Context not available.

This is an archive of the discontinued LLVM Phabricator instance.

[Documentation] Remove duplicated checks groups descriptions form clang-tidy/index.rstClosedPublic

Details

Diff Detail

Event Timeline

Revision Contents

Diff 68295

docs/clang-tidy/index.rst

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