[clang-tools-extra] 12bdbe2 - [clang-tidy][NFC][DOC] Add missing HICPP rule id's (#72553)

[via cfe-commits]

Author: Björn Svensson
Date: 2023-11-17T22:37:42+01:00
New Revision: 12bdbe2792b53ee1253c508b44f24d43735e7de9

URL: https://github.com/llvm/llvm-project/commit/12bdbe2792b53ee1253c508b44f24d43735e7de9
DIFF: https://github.com/llvm/llvm-project/commit/12bdbe2792b53ee1253c508b44f24d43735e7de9.diff

LOG: [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: 2634bd599567842385e11d1fd70f5486c166f935

Added: 
    

Modified: 
    clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst
    clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst
    clang-tools-extra/docs/clang-tidy/checks/hicpp/no-assembler.rst

Removed: 
    


################################################################################
diff  --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst
index 5d125a89e7f4324..789235980ad7b78 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst
@@ -8,3 +8,4 @@ hicpp-avoid-c-arrays
 The hicpp-avoid-c-arrays check is an alias, please see
 :doc:`modernize-avoid-c-arrays <../modernize/avoid-c-arrays>`
 for more information.
+It partly enforces the `rule 4.1.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-conversions>`_.

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst
index ffef01ca5d4eb17..ccc2a7b34efe540 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst
@@ -5,10 +5,7 @@
 hicpp-avoid-goto
 ================
 
-The `hicpp-avoid-goto` check is an alias to
-:doc:`cppcoreguidelines-avoid-goto <../cppcoreguidelines/avoid-goto>`.
-Rule `6.3.1 High Integrity C++ <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
-requires that ``goto`` only skips parts of a block and is not used for other
-reasons.
-
-Both coding guidelines implement the same exception to the usage of ``goto``.
+The `hicpp-avoid-goto` check is an alias, please see
+:doc:`cppcoreguidelines-avoid-goto <../cppcoreguidelines/avoid-goto>`
+for more information.
+It enforces the `rule 6.3.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_.

diff  --git a/clang-tools-extra/docs/clang-tidy/checks/hicpp/no-assembler.rst b/clang-tools-extra/docs/clang-tidy/checks/hicpp/no-assembler.rst
index 381fb365e800ea3..cfc6e9b6ec3477a 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/hicpp/no-assembler.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/hicpp/no-assembler.rst
@@ -1,10 +1,10 @@
 .. title:: clang-tidy - hicpp-no-assembler
 
 hicpp-no-assembler
-===================
+==================
 
-Check for assembler statements. No fix is offered.
+Checks for assembler statements. Use of inline assembly should be avoided since
+it restricts the portability of the code.
 
-Inline assembler is forbidden by the `High Integrity C++ Coding Standard
-<https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_
-as it restricts the portability of code.
+This enforces `rule 7.5.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_
+of the High Integrity C++ Coding Standard.