Skip to content

[clang-tidy][NFC] Fix formatting issue in clang-tidy documentations #168722

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

[clang-tidy][NFC] Fix formatting issue in clang-tidy documentations #168722

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,21 +96,22 @@ to be checked. The format is the following, without newlines:
The functions are matched using POSIX extended regular expressions.
*(Note: The regular expressions do not support negative* ``(?!)`` *matches.)*

The ``reason`` is optional and is used to provide additional information about the
reasoning behind the replacement. The default reason is ``is marked as unsafe``.
The ``reason`` is optional and is used to provide additional information about
the reasoning behind the replacement. The default reason is
``is marked as unsafe``.

If ``replacement`` is empty, the default text ``it should not be used`` will be
shown instead of the suggestion for a replacement.

If the ``reason`` starts with the character ``>``, the reason becomes fully custom.
The default suffix is disabled even if a ``replacement`` is present, and only the
reason message is shown after the matched function, to allow better control over
the suggestions. (The starting ``>`` and whitespace directly after it are
trimmed from the message.)
If the ``reason`` starts with the character ``>``, the reason becomes fully
custom. The default suffix is disabled even if a ``replacement`` is present,
and only the reason message is shown after the matched function, to allow
better control over the suggestions. (The starting ``>`` and whitespace
directly after it are trimmed from the message.)

As an example, the following configuration matches only the function ``original``
in the default namespace. A similar diagnostic can also be printed using a fully
custom reason.
As an example, the following configuration matches only the function
``original`` in the default namespace. A similar diagnostic can also be printed
using a fully custom reason.

.. code:: c

Expand All @@ -123,10 +124,10 @@ custom reason.
::std::original(); // no-warning
original_function(); // no-warning

If the regular expression contains the character ``:``, it is matched against the
qualified name (i.e. ``std::original``), otherwise the regex is matched against
the unqualified name (``original``). If the regular expression starts with ``::``
(or ``^::``), it is matched against the fully qualified name
If the regular expression contains the character ``:``, it is matched against
the qualified name (i.e. ``std::original``), otherwise the regex is matched
against the unqualified name (``original``). If the regular expression starts
with ``::`` (or ``^::``), it is matched against the fully qualified name
(``::std::original``).

One of the use cases for fully custom messages is suggesting compiler options
Expand Down
Loading