Skip to content

Commit ebc55e3

Browse files
committed
Revert "Move extra functions description out of each individual option"
This reverts commit e326e07.
1 parent 1d8312f commit ebc55e3

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

clang-tools-extra/docs/clang-tidy/checks/bugprone/raw-memory-call-on-non-trivial-type.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,31 @@ bugprone-raw-memory-call-on-non-trivial-type
66
Flags use of the C standard library functions ``memset``, ``memcpy`` and
77
``memcmp`` and similar derivatives on non-trivial types.
88

9-
For each option, it is possible to flag extra functions that act similarly.
10-
Specify names in a semicolon-delimited list.
11-
The default is an empty string.
12-
139
Options
1410
-------
1511

1612
.. option:: MemSetNames
1713

14+
Specify extra functions to flag that act similarly to ``memset``.
15+
Specify names in a semicolon delimited list.
16+
Default is an empty string.
1817
The check will detect the following functions:
1918
``memset``, ``std::memset``.
2019

2120
.. option:: MemCpyNames
2221

22+
Specify extra functions to flag that act similarly to ``memcpy``.
23+
Specify names in a semicolon delimited list.
24+
Default is an empty string.
2325
The check will detect the following functions:
2426
`std::memcpy`, ``memcpy`, `std::memmove`, ``memmove``, ``std::strcpy``,
2527
``strcpy``, ``memccpy``, ``stpncpy``, ``strncpy``.
2628

2729
.. option:: MemCmpNames
2830

31+
Specify extra functions to flag that act similarly to ``memcmp``.
32+
Specify names in a semicolon delimited list.
33+
Default is an empty string.
2934
The check will detect the following functions:
3035
``std::memcmp``, ``memcmp``, ``std::strcmp``, ``strcmp``, ``strncmp``.
3136

0 commit comments

Comments
 (0)