Skip to content

Commit 12bdbe2

Browse files
authored
[clang-tidy][NFC][DOC] Add missing HICPP rule id's (#72553)
Add HICPP rule identities to the documentation for `hicpp-avoid-c-arrays` and `hicpp-no-assembler`. Includes an update of `hicpp-avoid-goto` to look like other aliased checks. References: * avoid-c-arrays Commit: 2634bd5
1 parent bd934fc commit 12bdbe2

File tree

3 files changed

+10
-12
lines changed

3 files changed

+10
-12
lines changed

clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ hicpp-avoid-c-arrays
88
The hicpp-avoid-c-arrays check is an alias, please see
99
:doc:`modernize-avoid-c-arrays <../modernize/avoid-c-arrays>`
1010
for more information.
11+
It partly enforces the `rule 4.1.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-conversions>`_.

clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,7 @@
55
hicpp-avoid-goto
66
================
77

8-
The `hicpp-avoid-goto` check is an alias to
9-
:doc:`cppcoreguidelines-avoid-goto <../cppcoreguidelines/avoid-goto>`.
10-
Rule `6.3.1 High Integrity C++ <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
11-
requires that ``goto`` only skips parts of a block and is not used for other
12-
reasons.
13-
14-
Both coding guidelines implement the same exception to the usage of ``goto``.
8+
The `hicpp-avoid-goto` check is an alias, please see
9+
:doc:`cppcoreguidelines-avoid-goto <../cppcoreguidelines/avoid-goto>`
10+
for more information.
11+
It enforces the `rule 6.3.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
.. title:: clang-tidy - hicpp-no-assembler
22

33
hicpp-no-assembler
4-
===================
4+
==================
55

6-
Check for assembler statements. No fix is offered.
6+
Checks for assembler statements. Use of inline assembly should be avoided since
7+
it restricts the portability of the code.
78

8-
Inline assembler is forbidden by the `High Integrity C++ Coding Standard
9-
<https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_
10-
as it restricts the portability of code.
9+
This enforces `rule 7.5.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_
10+
of the High Integrity C++ Coding Standard.

0 commit comments

Comments
 (0)