mirror of
https://github.com/capstone-engine/llvm-capstone.git
synced 2024-11-30 17:21:10 +00:00
[clang-tidy][NFC][DOC] Update links to HICPP standard
Old links pointed out to old domain, and then redirected to correct one, but to wrong pages. Changed links from old to new domain and page. Fixes: #65064
This commit is contained in:
parent
4ea8212775
commit
c6fa07ca96
@ -8,5 +8,6 @@ Any file referencing a High-Integrity C++ Coding guideline:
|
||||
|
||||
HIC++ Coding Standard as created by PRQA.
|
||||
|
||||
Please see http://www.codingstandard.com/section/conditions-of-use/ for more
|
||||
information.
|
||||
Please see
|
||||
https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/conditions-of-use
|
||||
for more information.
|
||||
|
@ -7,7 +7,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++ <http://www.codingstandard.com/rule/6-3-1-ensure-that-the-labels-for-a-jump-statement-or-a-switch-condition-appear-later-in-the-same-or-an-enclosing-block/>`_
|
||||
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.
|
||||
|
||||
|
@ -8,4 +8,4 @@ hicpp-braces-around-statements
|
||||
The `hicpp-braces-around-statements` check is an alias, please see
|
||||
:doc:`readability-braces-around-statements <../readability/braces-around-statements>`
|
||||
for more information.
|
||||
It enforces the `rule 6.1.1 <http://www.codingstandard.com/rule/6-1-1-enclose-the-body-of-a-selection-or-an-iteration-statement-in-a-compound-statement/>`_.
|
||||
It enforces the `rule 6.1.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_.
|
||||
|
@ -8,4 +8,4 @@ hicpp-deprecated-headers
|
||||
The `hicpp-deprecated-headers` check is an alias, please see
|
||||
:doc:`modernize-deprecated-headers <../modernize/deprecated-headers>`
|
||||
for more information.
|
||||
It enforces the `rule 1.3.3 <http://www.codingstandard.com/rule/1-3-3-do-not-use-the-c-standard-library-h-headers/>`_.
|
||||
It enforces the `rule 1.3.3 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/general>`_.
|
||||
|
@ -6,7 +6,7 @@ hicpp-exception-baseclass
|
||||
Ensure that every value that in a ``throw`` expression is an instance of
|
||||
``std::exception``.
|
||||
|
||||
This enforces `rule 15.1 <http://www.codingstandard.com/section/15-1-throwing-an-exception/>`_
|
||||
This enforces `rule 15.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-exception-handling>`_
|
||||
of the High Integrity C++ Coding Standard.
|
||||
|
||||
.. code-block:: c++
|
||||
|
@ -6,7 +6,7 @@ hicpp-explicit-conversions
|
||||
==========================
|
||||
|
||||
This check is an alias for :doc:`google-explicit-constructor <../google/explicit-constructor>`.
|
||||
Used to enforce parts of `rule 5.4.1 <http://www.codingstandard.com/rule/5-4-1-only-use-casting-forms-static_cast-excl-void-dynamic_cast-or-explicit-constructor-call/>`_.
|
||||
Used to enforce parts of `rule 5.4.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-expressions>`_.
|
||||
This check will enforce that constructors and conversion operators are marked `explicit`.
|
||||
Other forms of casting checks are implemented in other places.
|
||||
The following checks can be used to check for more forms of casting:
|
||||
|
@ -8,6 +8,6 @@ hicpp-function-size
|
||||
This check is an alias for :doc:`readability-function-size <../readability/function-size>`.
|
||||
Useful to enforce multiple sections on function complexity.
|
||||
|
||||
- `rule 8.2.2 <http://www.codingstandard.com/rule/8-2-2-do-not-declare-functions-with-an-excessive-number-of-parameters/>`_
|
||||
- `rule 8.3.1 <http://www.codingstandard.com/rule/8-3-1-do-not-write-functions-with-an-excessive-mccabe-cyclomatic-complexity/>`_
|
||||
- `rule 8.3.2 <http://www.codingstandard.com/rule/8-3-2-do-not-write-functions-with-a-high-static-program-path-count/>`_
|
||||
- `rule 8.2.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_
|
||||
- `rule 8.3.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_
|
||||
- `rule 8.3.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_
|
||||
|
@ -7,4 +7,4 @@ hicpp-invalid-access-moved
|
||||
|
||||
This check is an alias for :doc:`bugprone-use-after-move <../bugprone/use-after-move>`.
|
||||
|
||||
Implements parts of the `rule 8.4.1 <http://www.codingstandard.com/rule/8-4-1-do-not-access-an-invalid-object-or-an-object-with-indeterminate-value/>`_ to check if moved-from objects are accessed.
|
||||
Implements parts of the `rule 8.4.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_ to check if moved-from objects are accessed.
|
||||
|
@ -7,5 +7,5 @@ hicpp-member-init
|
||||
|
||||
This check is an alias for :doc:`cppcoreguidelines-pro-type-member-init <../cppcoreguidelines/pro-type-member-init>`.
|
||||
Implements the check for
|
||||
`rule 12.4.2 <http://www.codingstandard.com/rule/12-4-2-ensure-that-a-constructor-initializes-explicitly-all-base-classes-and-non-static-data-members/>`_
|
||||
`rule 12.4.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_
|
||||
to initialize class members in the right order.
|
||||
|
@ -7,4 +7,4 @@ hicpp-move-const-arg
|
||||
|
||||
The `hicpp-move-const-arg` check is an alias, please see
|
||||
:doc:`performance-move-const-arg <../performance/move-const-arg>` for more information.
|
||||
It enforces the `rule 17.3.1 <http://www.codingstandard.com/rule/17-3-1-do-not-use-stdmove-on-objects-declared-with-const-or-const-type/>`_.
|
||||
It enforces the `rule 17.3.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-library>`_.
|
||||
|
@ -5,8 +5,8 @@ hicpp-multiway-paths-covered
|
||||
|
||||
This check discovers situations where code paths are not fully-covered.
|
||||
It furthermore suggests using ``if`` instead of ``switch`` if the code will be more clear.
|
||||
The `rule 6.1.2 <http://www.codingstandard.com/rule/6-1-2-explicitly-cover-all-paths-through-multi-way-selection-statements/>`_
|
||||
and `rule 6.1.4 <http://www.codingstandard.com/rule/6-1-4-ensure-that-a-switch-statement-has-at-least-two-case-labels-distinct-from-the-default-label/>`_
|
||||
The `rule 6.1.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
|
||||
and `rule 6.1.4 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
|
||||
of the High Integrity C++ Coding Standard are enforced.
|
||||
|
||||
``if-else if`` chains that miss a final ``else`` branch might lead to unexpected
|
||||
@ -57,7 +57,7 @@ Similar arguments hold for ``switch`` statements which do not cover all possible
|
||||
}
|
||||
|
||||
|
||||
The `rule 6.1.4 <http://www.codingstandard.com/rule/6-1-4-ensure-that-a-switch-statement-has-at-least-two-case-labels-distinct-from-the-default-label/>`_
|
||||
The `rule 6.1.4 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
|
||||
requires every ``switch`` statement to have at least two ``case`` labels other than a `default` label.
|
||||
Otherwise, the ``switch`` could be better expressed with an ``if`` statement.
|
||||
Degenerated ``switch`` statements without any labels are caught as well.
|
||||
|
@ -7,4 +7,4 @@ hicpp-named-parameter
|
||||
|
||||
This check is an alias for :doc:`readability-named-parameter <../readability/named-parameter>`.
|
||||
|
||||
Implements `rule 8.2.1 <http://www.codingstandard.com/rule/8-2-1-make-parameter-names-absent-or-identical-in-all-declarations/>`_.
|
||||
Implements `rule 8.2.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_.
|
||||
|
@ -6,5 +6,5 @@ hicpp-new-delete-operators
|
||||
==========================
|
||||
|
||||
This check is an alias for :doc:`misc-new-delete-overloads <../misc/new-delete-overloads>`.
|
||||
Implements `rule 12.3.1 <http://www.codingstandard.com/section/12-3-free-store/>`_ to ensure
|
||||
Implements `rule 12.3.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_ to ensure
|
||||
the `new` and `delete` operators have the correct signature.
|
||||
|
@ -8,4 +8,4 @@ hicpp-no-array-decay
|
||||
The `hicpp-no-array-decay` check is an alias, please see
|
||||
:doc:`cppcoreguidelines-pro-bounds-array-to-pointer-decay <../cppcoreguidelines/pro-bounds-array-to-pointer-decay>`
|
||||
for more information.
|
||||
It enforces the `rule 4.1.1 <http://www.codingstandard.com/section/4-1-array-to-pointer-conversion/>`_.
|
||||
It enforces the `rule 4.1.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-conversions>`_.
|
||||
|
@ -6,5 +6,5 @@ hicpp-no-assembler
|
||||
Check for assembler statements. No fix is offered.
|
||||
|
||||
Inline assembler is forbidden by the `High Integrity C++ Coding Standard
|
||||
<http://www.codingstandard.com/section/7-5-the-asm-declaration/>`_
|
||||
<https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_
|
||||
as it restricts the portability of code.
|
||||
|
@ -8,4 +8,4 @@ hicpp-no-malloc
|
||||
The `hicpp-no-malloc` check is an alias, please see
|
||||
:doc:`cppcoreguidelines-no-malloc <../cppcoreguidelines/no-malloc>`
|
||||
for more information.
|
||||
It enforces the `rule 5.3.2 <http://www.codingstandard.com/rule/5-3-2-allocate-memory-using-new-and-release-it-using-delete/>`_.
|
||||
It enforces the `rule 5.3.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-expressions>`_.
|
||||
|
@ -7,4 +7,4 @@ hicpp-noexcept-move
|
||||
|
||||
This check is an alias for :doc:`performance-noexcept-move-constructor
|
||||
<../performance/noexcept-move-constructor>`.
|
||||
Checks `rule 12.5.4 <http://www.codingstandard.com/rule/12-5-4-declare-noexcept-the-move-constructor-and-move-assignment-operator>`_ to mark move assignment and move construction `noexcept`.
|
||||
Checks `rule 12.5.4 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_ to mark move assignment and move construction `noexcept`.
|
||||
|
@ -6,7 +6,7 @@ hicpp-signed-bitwise
|
||||
Finds uses of bitwise operations on signed integer types, which may lead to
|
||||
undefined or implementation defined behavior.
|
||||
|
||||
The according rule is defined in the `High Integrity C++ Standard, Section 5.6.1 <http://www.codingstandard.com/section/5-6-shift-operators/>`_.
|
||||
The according rule is defined in the `High Integrity C++ Standard, Section 5.6.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-expressions>`_.
|
||||
|
||||
Options
|
||||
-------
|
||||
|
@ -6,4 +6,4 @@ hicpp-special-member-functions
|
||||
==============================
|
||||
|
||||
This check is an alias for :doc:`cppcoreguidelines-special-member-functions <../cppcoreguidelines/special-member-functions>`.
|
||||
Checks that special member functions have the correct signature, according to `rule 12.5.7 <http://www.codingstandard.com/rule/12-5-7-declare-assignment-operators-with-the-ref-qualifier/>`_.
|
||||
Checks that special member functions have the correct signature, according to `rule 12.5.7 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_.
|
||||
|
@ -7,4 +7,4 @@ hicpp-static-assert
|
||||
|
||||
The `hicpp-static-assert` check is an alias, please see
|
||||
:doc:`misc-static-assert <../misc/static-assert>` for more information.
|
||||
It enforces the `rule 7.1.10 <http://www.codingstandard.com/rule/6-1-1-enclose-the-body-of-a-selection-or-an-iteration-statement-in-a-compound-statement/>`_.
|
||||
It enforces the `rule 7.1.10 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_.
|
||||
|
@ -6,7 +6,7 @@ hicpp-undelegated-constructor
|
||||
=============================
|
||||
|
||||
This check is an alias for :doc:`bugprone-undelegated-constructor <../bugprone/undelegated-constructor>`.
|
||||
Partially implements `rule 12.4.5 <http://www.codingstandard.com/rule/12-4-5-use-delegating-constructors-to-reduce-code-duplication/>`_
|
||||
Partially implements `rule 12.4.5 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_
|
||||
to find misplaced constructor calls inside a constructor.
|
||||
|
||||
.. code-block:: c++
|
||||
|
@ -7,3 +7,6 @@ hicpp-uppercase-literal-suffix
|
||||
|
||||
The hicpp-uppercase-literal-suffix check is an alias, please see
|
||||
:doc:`readability-uppercase-literal-suffix <../readability/uppercase-literal-suffix>` for more information.
|
||||
|
||||
Partially implements `rule 4.2.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-conversions>`_
|
||||
to ensure that the ``U`` suffix is writeln properly.
|
||||
|
@ -7,4 +7,4 @@ hicpp-use-auto
|
||||
|
||||
The `hicpp-use-auto` check is an alias, please see
|
||||
:doc:`modernize-use-auto <../modernize/use-auto>` for more information.
|
||||
It enforces the `rule 7.1.8 <http://www.codingstandard.com/rule/7-1-8-use-auto-id-expr-when-declaring-a-variable-to-have-the-same-type-as-its-initializer-function-call/>`_.
|
||||
It enforces the `rule 7.1.8 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/declarations>`_.
|
||||
|
@ -7,4 +7,4 @@ hicpp-use-emplace
|
||||
|
||||
The `hicpp-use-emplace` check is an alias, please see
|
||||
:doc:`modernize-use-emplace <../modernize/use-emplace>` for more information.
|
||||
It enforces the `rule 17.4.2 <http://www.codingstandard.com/rule/17-4-2-use-api-calls-that-construct-objects-in-place/>`_.
|
||||
It enforces the `rule 17.4.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-library>`_.
|
||||
|
@ -6,4 +6,4 @@ hicpp-use-equals-default
|
||||
========================
|
||||
|
||||
This check is an alias for :doc:`modernize-use-equals-default <../modernize/use-equals-default>`.
|
||||
Implements `rule 12.5.1 <http://www.codingstandard.com/rule/12-5-1-define-explicitly-default-or-delete-implicit-special-member-functions-of-concrete-classes/>`_ to explicitly default special member functions.
|
||||
Implements `rule 12.5.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_ to explicitly default special member functions.
|
||||
|
@ -6,5 +6,5 @@ hicpp-use-equals-delete
|
||||
=======================
|
||||
|
||||
This check is an alias for :doc:`modernize-use-equals-delete <../modernize/use-equals-delete>`.
|
||||
Implements `rule 12.5.1 <http://www.codingstandard.com/rule/12-5-1-define-explicitly-default-or-delete-implicit-special-member-functions-of-concrete-classes/>`_
|
||||
Implements `rule 12.5.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/special-member-functions>`_
|
||||
to explicitly default or delete special member functions.
|
||||
|
@ -7,4 +7,4 @@ hicpp-use-noexcept
|
||||
|
||||
The `hicpp-use-noexcept` check is an alias, please see
|
||||
:doc:`modernize-use-noexcept <../modernize/use-noexcept>` for more information.
|
||||
It enforces the `rule 1.3.5 <http://www.codingstandard.com/rule/1-3-5-do-not-use-throw-exception-specifications/>`_.
|
||||
It enforces the `rule 1.3.5 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/general>`_.
|
||||
|
@ -7,4 +7,4 @@ hicpp-use-nullptr
|
||||
|
||||
The `hicpp-use-nullptr` check is an alias, please see
|
||||
:doc:`modernize-use-nullptr <../modernize/use-nullptr>` for more information.
|
||||
It enforces the `rule 2.5.3 <http://www.codingstandard.com/rule/2-5-3-use-nullptr-for-the-null-pointer-constant/>`_.
|
||||
It enforces the `rule 2.5.3 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/lexical-conventions>`_.
|
||||
|
@ -6,5 +6,5 @@ hicpp-use-override
|
||||
==================
|
||||
|
||||
This check is an alias for :doc:`modernize-use-override <../modernize/use-override>`.
|
||||
Implements `rule 10.2.1 <http://www.codingstandard.com/section/10-2-virtual-functions/>`_ to
|
||||
Implements `rule 10.2.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/derived-classes>`_ to
|
||||
declare a virtual function `override` when overriding.
|
||||
|
@ -8,4 +8,4 @@ hicpp-vararg
|
||||
The `hicpp-vararg` check is an alias, please see
|
||||
:doc:`cppcoreguidelines-pro-type-vararg <../cppcoreguidelines/pro-type-vararg>`
|
||||
for more information.
|
||||
It enforces the `rule 14.1.1 <http://www.codingstandard.com/section/14-1-template-declarations/>`_.
|
||||
It enforces the `rule 14.1.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/templates>`_.
|
||||
|
@ -10,7 +10,7 @@ Many coding guidelines advise replacing the magic values with symbolic
|
||||
constants to improve readability. Here are a few references:
|
||||
|
||||
* `Rule ES.45: Avoid "magic constants"; use symbolic constants in C++ Core Guidelines <https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Res-magic>`_
|
||||
* `Rule 5.1.1 Use symbolic names instead of literal values in code in High Integrity C++ <http://www.codingstandard.com/rule/5-1-1-use-symbolic-names-instead-of-literal-values-in-code/>`_
|
||||
* `Rule 5.1.1 Use symbolic names instead of literal values in code in High Integrity C++ <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-expressions>`_
|
||||
* Item 17 in "C++ Coding Standards: 101 Rules, Guidelines and Best
|
||||
Practices" by Herb Sutter and Andrei Alexandrescu
|
||||
* Chapter 17 in "Clean Code - A handbook of agile software craftsmanship."
|
||||
|
Loading…
Reference in New Issue
Block a user