aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBaranov Victor <70346889+vbvictor@users.noreply.github.com>2025-01-29 20:30:56 +0300
committerGitHub <noreply@github.com>2025-01-29 12:30:56 -0500
commit15412d735a4f3e85b1c68025ca28d5671fde7b47 (patch)
treeeba6db9f89a47caa355d6b3cd4ff9c15d794dfe3
parent0d4efa27252cbbea4b5672d4d8ffc15a3ba51d83 (diff)
downloadllvm-15412d735a4f3e85b1c68025ca28d5671fde7b47.zip
llvm-15412d735a4f3e85b1c68025ca28d5671fde7b47.tar.gz
llvm-15412d735a4f3e85b1c68025ca28d5671fde7b47.tar.bz2
[clang-tidy] Refactor: remove typos in 'AllowedTypes' option in various checks (#122957)
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst10
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/performance/for-range-copy.rst13
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-copy-initialization.rst10
-rw-r--r--clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst10
4 files changed, 22 insertions, 21 deletions
diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst
index 8ba84ff..1355afa 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/assert-side-effect.rst
@@ -26,8 +26,8 @@ Options
A semicolon-separated list of the names of functions or methods to be
considered as not having side-effects. Regular expressions are accepted,
- e.g. `[Rr]ef(erence)?$` matches every type with suffix `Ref`, `ref`,
- `Reference` and `reference`. The default is empty. If a name in the list
- contains the sequence `::` it is matched against the qualified typename
- (i.e. `namespace::Type`, otherwise it is matched against only
- the type name (i.e. `Type`).
+ e.g. ``[Rr]ef(erence)?$`` matches every type with suffix ``Ref``, ``ref``,
+ ``Reference`` and ``reference``. The default is empty. If a name in the list
+ contains the sequence `::` it is matched against the qualified type name
+ (i.e. ``namespace::Type``), otherwise it is matched against only
+ the type name (i.e. ``Type``).
diff --git a/clang-tools-extra/docs/clang-tidy/checks/performance/for-range-copy.rst b/clang-tools-extra/docs/clang-tidy/checks/performance/for-range-copy.rst
index 01fde95..d740984 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/performance/for-range-copy.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/performance/for-range-copy.rst
@@ -23,14 +23,15 @@ Options
.. option:: WarnOnAllAutoCopies
- When `true`, warns on any use of `auto` as the type of the range-based for
+ When `true`, warns on any use of ``auto`` as the type of the range-based for
loop variable. Default is `false`.
.. option:: AllowedTypes
A semicolon-separated list of names of types allowed to be copied in each
- iteration. Regular expressions are accepted, e.g. `[Rr]ef(erence)?$` matches
- every type with suffix `Ref`, `ref`, `Reference` and `reference`. The default
- is empty. If a name in the list contains the sequence `::` it is matched
- against the qualified typename (i.e. `namespace::Type`, otherwise it is
- matched against only the type name (i.e. `Type`).
+ iteration. Regular expressions are accepted, e.g. ``[Rr]ef(erence)?$``
+ matches every type with suffix ``Ref``, ``ref``, ``Reference`` and
+ ``reference``. The default is empty. If a name in the list contains the
+ sequence `::`, it is matched against the qualified type name
+ (i.e. ``namespace::Type``), otherwise it is matched against only the
+ type name (i.e. ``Type``).
diff --git a/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-copy-initialization.rst b/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-copy-initialization.rst
index 83728381..bb4f42c 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-copy-initialization.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-copy-initialization.rst
@@ -42,11 +42,11 @@ Options
.. option:: AllowedTypes
A semicolon-separated list of names of types allowed to be initialized by
- copying. Regular expressions are accepted, e.g. `[Rr]ef(erence)?$` matches
- every type with suffix `Ref`, `ref`, `Reference` and `reference`. The default
- is empty. If a name in the list contains the sequence `::` it is matched
- against the qualified typename (i.e. `namespace::Type`, otherwise it is
- matched against only the type name (i.e. `Type`).
+ copying. Regular expressions are accepted, e.g. ``[Rr]ef(erence)?$`` matches
+ every type with suffix ``Ref``, ``ref``, ``Reference`` and ``reference``.
+ The default is empty. If a name in the list contains the sequence `::`, it
+ is matched against the qualified type name (i.e. ``namespace::Type``),
+ otherwise it is matched against only the type name (i.e. ``Type``).
.. option:: ExcludedContainerTypes
diff --git a/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst b/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst
index cc5e1ae..d13c53e 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/performance/unnecessary-value-param.rst
@@ -65,8 +65,8 @@ Options
.. option:: AllowedTypes
A semicolon-separated list of names of types allowed to be passed by value.
- Regular expressions are accepted, e.g. `[Rr]ef(erence)?$` matches every type
- with suffix `Ref`, `ref`, `Reference` and `reference`. The default is
- empty. If a name in the list contains the sequence `::` it is matched against
- the qualified typename (i.e. `namespace::Type`, otherwise it is matched
- against only the type name (i.e. `Type`).
+ Regular expressions are accepted, e.g. ``[Rr]ef(erence)?$`` matches every
+ type with suffix ``Ref``, ``ref``, ``Reference`` and ``reference``. The
+ default is empty. If a name in the list contains the sequence `::`, it is
+ matched against the qualified type name (i.e. ``namespace::Type``),
+ otherwise it is matched against only the type name (i.e. ``Type``).