Skip to content

Commit 99a4156

Browse files
zeyi2github-actions[bot]
authored andcommitted
Automerge: [clang-tidy][docs][NFC] Enforce 80 characters limit (3/N) (#167830)
Fix documentation in `hicpp`, `linuxkernel`, `llvm`, `llvmlibc`, `misc` and `modernize`. This is part of the codebase cleanup described in llvm/llvm-project#167098
2 parents 06329a7 + 74c4029 commit 99a4156

38 files changed

+183
-132
lines changed

clang-tools-extra/docs/clang-tidy/checks/hicpp/braces-around-statements.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ hicpp-braces-around-statements
66
==============================
77

88
The `hicpp-braces-around-statements` check is an alias, please see
9-
:doc:`readability-braces-around-statements <../readability/braces-around-statements>`
9+
:doc:`readability-braces-around-statements
10+
<../readability/braces-around-statements>`
1011
for more information.
11-
It enforces the `rule 6.1.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_.
12+
It enforces the `rule 6.1.1
13+
<https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_.

clang-tools-extra/docs/clang-tidy/checks/hicpp/explicit-conversions.rst

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,21 @@
55
hicpp-explicit-conversions
66
==========================
77

8-
This check is an alias for :doc:`google-explicit-constructor <../google/explicit-constructor>`.
9-
Used to enforce parts of `rule 5.4.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-expressions>`_.
10-
This check will enforce that constructors and conversion operators are marked `explicit`.
11-
Other forms of casting checks are implemented in other places.
12-
The following checks can be used to check for more forms of casting:
8+
This check is an alias for
9+
:doc:`google-explicit-constructor <../google/explicit-constructor>`.
1310

14-
- :doc:`cppcoreguidelines-pro-type-static-cast-downcast <../cppcoreguidelines/pro-type-static-cast-downcast>`
15-
- :doc:`cppcoreguidelines-pro-type-reinterpret-cast <../cppcoreguidelines/pro-type-reinterpret-cast>`
16-
- :doc:`cppcoreguidelines-pro-type-const-cast <../cppcoreguidelines/pro-type-const-cast>`
17-
- :doc:`cppcoreguidelines-pro-type-cstyle-cast <../cppcoreguidelines/pro-type-cstyle-cast>`
11+
Used to enforce parts of `rule 5.4.1
12+
<https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard-expressions>`_.
13+
This check will enforce that constructors and conversion operators are
14+
marked ``explicit``. Other forms of casting checks are implemented in
15+
other places. The following checks can be used to check for more forms
16+
of casting:
17+
18+
- :doc:`cppcoreguidelines-pro-type-static-cast-downcast
19+
<../cppcoreguidelines/pro-type-static-cast-downcast>`
20+
- :doc:`cppcoreguidelines-pro-type-reinterpret-cast
21+
<../cppcoreguidelines/pro-type-reinterpret-cast>`
22+
- :doc:`cppcoreguidelines-pro-type-const-cast
23+
<../cppcoreguidelines/pro-type-const-cast>`
24+
- :doc:`cppcoreguidelines-pro-type-cstyle-cast
25+
<../cppcoreguidelines/pro-type-cstyle-cast>`

clang-tools-extra/docs/clang-tidy/checks/hicpp/function-size.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
hicpp-function-size
66
===================
77

8-
This check is an alias for :doc:`readability-function-size <../readability/function-size>`.
8+
This check is an alias for
9+
:doc:`readability-function-size <../readability/function-size>`.
910
Useful to enforce multiple sections on function complexity.
1011

1112
- `rule 8.2.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_

clang-tools-extra/docs/clang-tidy/checks/hicpp/ignored-remove-result.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ operating over. On completion, they return an iterator to the last valid
1313
element. In the majority of cases the correct behavior is to use this result as
1414
the first operand in a call to ``std::erase``.
1515

16-
This check is a subset of :doc:`bugprone-unused-return-value <../bugprone/unused-return-value>`
16+
This check is a subset of :doc:`bugprone-unused-return-value
17+
<../bugprone/unused-return-value>`
1718
and depending on used options it can be superfluous to enable both checks.
1819

1920
Options

clang-tools-extra/docs/clang-tidy/checks/hicpp/invalid-access-moved.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
hicpp-invalid-access-moved
66
==========================
77

8-
This check is an alias for :doc:`bugprone-use-after-move <../bugprone/use-after-move>`.
8+
This check is an alias for
9+
:doc:`bugprone-use-after-move <../bugprone/use-after-move>`.
910

1011
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.

clang-tools-extra/docs/clang-tidy/checks/hicpp/move-const-arg.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ hicpp-move-const-arg
66
====================
77

88
The `hicpp-move-const-arg` check is an alias, please see
9-
:doc:`performance-move-const-arg <../performance/move-const-arg>` for more information.
9+
:doc:`performance-move-const-arg <../performance/move-const-arg>`
10+
for more information.
1011
It enforces the `rule 17.3.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-library>`_.

clang-tools-extra/docs/clang-tidy/checks/hicpp/multiway-paths-covered.rst

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,16 @@ hicpp-multiway-paths-covered
44
============================
55

66
This check discovers situations where code paths are not fully-covered.
7-
It furthermore suggests using ``if`` instead of ``switch`` if the code will be more clear.
7+
It furthermore suggests using ``if`` instead of ``switch`` if the code
8+
will be more clear.
89
The `rule 6.1.2 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
910
and `rule 6.1.4 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/statements>`_
1011
of the High Integrity C++ Coding Standard are enforced.
1112

12-
``if-else if`` chains that miss a final ``else`` branch might lead to unexpected
13-
program execution and be the result of a logical error.
14-
If the missing ``else`` branch is intended you can leave it empty with a clarifying
15-
comment.
13+
``if-else if`` chains that miss a final ``else`` branch might lead to
14+
unexpected program execution and be the result of a logical error.
15+
If the missing ``else`` branch is intended you can leave it empty with
16+
a clarifying comment.
1617
This warning can be noisy on some code bases, so it is disabled by default.
1718

1819
.. code-block:: c++
@@ -28,7 +29,8 @@ This warning can be noisy on some code bases, so it is disabled by default.
2829
// ...
2930
}
3031

31-
Similar arguments hold for ``switch`` statements which do not cover all possible code paths.
32+
Similar arguments hold for ``switch`` statements which do not cover all
33+
possible code paths.
3234

3335
.. code-block:: c++
3436

clang-tools-extra/docs/clang-tidy/checks/hicpp/named-parameter.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
hicpp-named-parameter
66
=====================
77

8-
This check is an alias for :doc:`readability-named-parameter <../readability/named-parameter>`.
8+
This check is an alias for :doc:`readability-named-parameter
9+
<../readability/named-parameter>`.
910

1011
Implements `rule 8.2.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/definitions>`_.

clang-tools-extra/docs/clang-tidy/checks/hicpp/no-array-decay.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ hicpp-no-array-decay
66
====================
77

88
The `hicpp-no-array-decay` check is an alias, please see
9-
:doc:`cppcoreguidelines-pro-bounds-array-to-pointer-decay <../cppcoreguidelines/pro-bounds-array-to-pointer-decay>`
9+
:doc:`cppcoreguidelines-pro-bounds-array-to-pointer-decay
10+
<../cppcoreguidelines/pro-bounds-array-to-pointer-decay>`
1011
for more information.
1112
It 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/uppercase-literal-suffix.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,8 @@ hicpp-uppercase-literal-suffix
66
==============================
77

88
The hicpp-uppercase-literal-suffix check is an alias, please see
9-
:doc:`readability-uppercase-literal-suffix <../readability/uppercase-literal-suffix>` for more information.
9+
:doc:`readability-uppercase-literal-suffix
10+
<../readability/uppercase-literal-suffix>` for more information.
1011

1112
Partially implements `rule 4.2.1 <https://www.perforce.com/resources/qac/high-integrity-cpp-coding-standard/standard-conversions>`_
1213
to ensure that the ``U`` suffix is writeln properly.

0 commit comments

Comments
 (0)