[clang-tools-extra] r345049 - [clang-tidy] Add a separate section for NOLINT(NEXTLINE)? doc.

Alexander Kornienko via cfe-commits cfe-commits at lists.llvm.org
Tue Oct 23 09:48:16 PDT 2018


Author: alexfh
Date: Tue Oct 23 09:48:16 2018
New Revision: 345049

URL: http://llvm.org/viewvc/llvm-project?rev=345049&view=rev
Log:
[clang-tidy] Add a separate section for NOLINT(NEXTLINE)? doc.

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

Modified: clang-tools-extra/trunk/docs/clang-tidy/index.rst
URL: http://llvm.org/viewvc/llvm-project/clang-tools-extra/trunk/docs/clang-tidy/index.rst?rev=345049&r1=345048&r2=345049&view=diff
==============================================================================
--- clang-tools-extra/trunk/docs/clang-tidy/index.rst (original)
+++ clang-tools-extra/trunk/docs/clang-tidy/index.rst Tue Oct 23 09:48:16 2018
@@ -255,16 +255,19 @@ An overview of all the command-line opti
           value:           'some value'
       ...
 
+Suppressing Undesired Diagnostics
+=================================
+
 :program:`clang-tidy` diagnostics are intended to call out code that does
 not adhere to a coding standard, or is otherwise problematic in some way.
 However, if it is known that the code is correct, the check-specific ways
-to silence the diagnostics could be used, if they are available (e.g. 
-bugprone-use-after-move can be silenced by re-initializing the variable after 
-it has been moved out, misc-string-integer-assignment can be suppressed by 
-explicitly casting the integer to char, readability-implicit-bool-conversion
-can also be suppressed by using explicit casts, etc.). If they are not 
-available or if changing the semantics of the code is not desired, 
-the ``NOLINT`` or ``NOLINTNEXTLINE`` comments can be used instead. For example:
+to silence the diagnostics could be used, if they are available (e.g.
+bugprone-use-after-move can be silenced by re-initializing the variable after it
+has been moved out, bugprone-string-integer-assignment can be suppressed by
+explicitly casting the integer to char, readability-implicit-bool-conversion can
+also be suppressed by using explicit casts, etc.). If they are not available or
+if changing the semantics of the code is not desired, the ``NOLINT`` or
+``NOLINTNEXTLINE`` comments can be used instead. For example:
 
 .. code-block:: c++
 




More information about the cfe-commits mailing list