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

Björn Svensson via cfe-commits cfe-commits at lists.llvm.org
Fri Nov 17 01:43:24 PST 2023


https://github.com/bjosv updated https://github.com/llvm/llvm-project/pull/72553

>From 2644f2a71fb144190f67dfd515746f9d185496c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Svensson?= <bjorn.a.svensson at est.tech>
Date: Thu, 16 Nov 2023 18:36:34 +0100
Subject: [PATCH 1/2] [clang-tidy][NFC][DOC] Add missing HICPP rule id's

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
---
 .../docs/clang-tidy/checks/hicpp/avoid-c-arrays.rst    |  1 +
 .../docs/clang-tidy/checks/hicpp/avoid-goto.rst        |  9 +++------
 .../docs/clang-tidy/checks/hicpp/no-assembler.rst      | 10 +++++-----
 3 files changed, 9 insertions(+), 11 deletions(-)

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..91ecaf0594d1f44 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
+The `hicpp-avoid-goto` check is an alias, please see
 :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``.
+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.

>From 009b82f6263616ee96c2de20957d05e135e19b8b Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20Svensson?= <bjorn.a.svensson at est.tech>
Date: Fri, 17 Nov 2023 10:39:32 +0100
Subject: [PATCH 2/2] Fixup: remove overlooked period

---
 clang-tools-extra/docs/clang-tidy/checks/hicpp/avoid-goto.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

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 91ecaf0594d1f44..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
@@ -6,6 +6,6 @@ hicpp-avoid-goto
 ================
 
 The `hicpp-avoid-goto` check is an alias, please see
-:doc:`cppcoreguidelines-avoid-goto <../cppcoreguidelines/avoid-goto>`.
+: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>`_.



More information about the cfe-commits mailing list