Skip to content

Commit 3cf574d

Browse files
authored
[clang-tidy][NFC] Document CERT rule coverage and aliases for some primary checks (#90965)
1 parent ca8b064 commit 3cf574d

File tree

5 files changed

+11
-2
lines changed

5 files changed

+11
-2
lines changed

clang-tools-extra/docs/clang-tidy/checks/bugprone/bad-signal-to-kill-thread.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,3 +14,5 @@ just the individual thread. Use any signal except ``SIGTERM``.
1414
This check corresponds to the CERT C Coding Standard rule
1515
`POS44-C. Do not use signals to terminate threads
1616
<https://wiki.sei.cmu.edu/confluence/display/c/POS44-C.+Do+not+use+signals+to+terminate+threads>`_.
17+
18+
`cert-pos44-c` redirects here as an alias of this check.

clang-tools-extra/docs/clang-tidy/checks/bugprone/macro-parentheses.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,7 @@ completely before it is used.
1717
It is also recommended to surround macro arguments in the replacement list
1818
with parentheses. This ensures that the argument value is calculated
1919
properly.
20+
21+
This check corresponds to the CERT C Coding Standard rule
22+
`PRE20-C. Macro replacement lists should be parenthesized.
23+
<https://wiki.sei.cmu.edu/confluence/display/c/PRE02-C.+Macro+replacement+lists+should+be+parenthesized>`_

clang-tools-extra/docs/clang-tidy/checks/bugprone/suspicious-memory-comparison.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,5 @@ This check is also related to and partially overlaps the CERT C++ Coding Standar
2929
and
3030
`EXP62-CPP. Do not access the bits of an object representation that are not part of the object's value representation
3131
<https://wiki.sei.cmu.edu/confluence/display/cplusplus/EXP62-CPP.+Do+not+access+the+bits+of+an+object+representation+that+are+not+part+of+the+object%27s+value+representation>`_
32+
33+
`cert-exp42-c` redirects here as an alias of this check.

clang-tools-extra/docs/clang-tidy/checks/concurrency/thread-canceltype-asynchronous.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,5 @@ be acted upon and the effect is as if it was an asynchronous cancellation.
1717
This check corresponds to the CERT C Coding Standard rule
1818
`POS47-C. Do not use threads that can be canceled asynchronously
1919
<https://wiki.sei.cmu.edu/confluence/display/c/POS47-C.+Do+not+use+threads+that+can+be+canceled+asynchronously>`_.
20+
21+
`cert-pos47-c` redirects here as an alias of this check.

clang-tools-extra/docs/clang-tidy/checks/misc/throw-by-value-catch-by-reference.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
misc-throw-by-value-catch-by-reference
44
======================================
55

6-
`cert-err09-cpp` redirects here as an alias for this check.
7-
`cert-err61-cpp` redirects here as an alias for this check.
6+
`cert-err09-cpp` and `cert-err61-cpp` redirect here as aliases of this check.
87

98
Finds violations of the rule "Throw by value, catch by reference" presented for
109
example in "C++ Coding Standards" by H. Sutter and A. Alexandrescu, as well as

0 commit comments

Comments
 (0)