Skip to content
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/con36-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ cert-con36-c
============

The `cert-con36-c` check is an alias, please see
:doc:`bugprone-spuriously-wake-up-functions <../bugprone/spuriously-wake-up-functions>`
:doc:`bugprone-spuriously-wake-up-functions
<../bugprone/spuriously-wake-up-functions>`
for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/con54-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ cert-con54-cpp
==============

The `cert-con54-cpp` check is an alias, please see
:doc:`bugprone-spuriously-wake-up-functions <../bugprone/spuriously-wake-up-functions>`
:doc:`bugprone-spuriously-wake-up-functions
<../bugprone/spuriously-wake-up-functions>`
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ cert-ctr56-cpp

The `cert-ctr56-cpp` check is an alias, please see
:doc:`bugprone-pointer-arithmetic-on-polymorphic-object
<../bugprone/pointer-arithmetic-on-polymorphic-object>` for more information.
<../bugprone/pointer-arithmetic-on-polymorphic-object>` for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/dcl16-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ cert-dcl16-c
============

The `cert-dcl16-c` check is an alias, please see
:doc:`readability-uppercase-literal-suffix <../readability/uppercase-literal-suffix>` for more information.
:doc:`readability-uppercase-literal-suffix
<../readability/uppercase-literal-suffix>` for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/dcl50-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ cert-dcl50-cpp
==============

The `cert-dcl50-cpp` check is an alias, please see
`modernize-avoid-variadic-functions <../modernize/avoid-variadic-functions.html>`_
`modernize-avoid-variadic-functions
<../modernize/avoid-variadic-functions.html>`_
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/dcl58-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ cert-dcl58-cpp
==============

The `cert-dcl58-cpp` is an aliaes, please see
`bugprone-std-namespace-modification <../bugprone/std-namespace-modification.html>`_
`bugprone-std-namespace-modification
<../bugprone/std-namespace-modification.html>`_
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/dcl59-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ cert-dcl59-cpp
==============

The `cert-dcl59-cpp` check is an alias, please see
:doc:`google-build-namespaces <../google/build-namespaces>` for more information.
:doc:`google-build-namespaces <../google/build-namespaces>`
for more information.
10 changes: 6 additions & 4 deletions clang-tools-extra/docs/clang-tidy/checks/cert/err09-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ cert-err09-cpp
==============

The `cert-err09-cpp` check is an alias, please see
:doc:`misc-throw-by-value-catch-by-reference <../misc/throw-by-value-catch-by-reference>`
:doc:`misc-throw-by-value-catch-by-reference
<../misc/throw-by-value-catch-by-reference>`
for more information.

This check corresponds to the CERT C++ Coding Standard recommendation
ERR09-CPP. Throw anonymous temporaries. However, all of the CERT recommendations
have been removed from public view, and so their justification for the behavior
of this check requires an account on their wiki to view.
ERR09-CPP. Throw anonymous temporaries. However, all of the CERT
recommendations have been removed from public view, and so their
justification for the behavior of this check requires an account on
their wiki to view.
4 changes: 2 additions & 2 deletions clang-tools-extra/docs/clang-tidy/checks/cert/err33-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -186,8 +186,8 @@ functions are checked:
* wscanf()
* wscanf_s()

This check is an alias of check :doc:`bugprone-unused-return-value <../bugprone/unused-return-value>`
with a fixed set of functions.
This check is an alias of check :doc:`bugprone-unused-return-value
<../bugprone/unused-return-value>` with a fixed set of functions.

Suppressing issues by casting to ``void`` is enabled by default and can be
disabled by setting `AllowCastToVoid` option to `false`.
Expand Down
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/err34-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ cert-err34-c
============

The cert-err34-c check is an alias, please see
`bugprone-unchecked-string-to-number-conversion <../bugprone/unchecked-string-to-number-conversion.html>`_
`bugprone-unchecked-string-to-number-conversion
<../bugprone/unchecked-string-to-number-conversion.html>`_
for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/err58-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ cert-err58-cpp
==============

The `cert-err58-cpp` check is an alias, please see
`bugprone-throwing-static-initialization <../bugprone/throwing-static-initialization.html>`_
`bugprone-throwing-static-initialization
<../bugprone/throwing-static-initialization.html>`_
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/err60-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ cert-err60-cpp
==============

The `cert-err60-cpp` check is an alias, please see
`bugprone-exception-copy-constructor-throws <../bugprone/exception-copy-constructor-throws.html>`_
`bugprone-exception-copy-constructor-throws
<../bugprone/exception-copy-constructor-throws.html>`_
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/err61-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ cert-err61-cpp
==============

The `cert-err61-cpp` check is an alias, please see
:doc:`misc-throw-by-value-catch-by-reference <../misc/throw-by-value-catch-by-reference>`
:doc:`misc-throw-by-value-catch-by-reference
<../misc/throw-by-value-catch-by-reference>`
for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/exp42-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ cert-exp42-c
============

The `cert-exp42-c` check is an alias, please see
:doc:`bugprone-suspicious-memory-comparison <../bugprone/suspicious-memory-comparison>` for more information.
:doc:`bugprone-suspicious-memory-comparison
<../bugprone/suspicious-memory-comparison>` for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/flp37-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@ cert-flp37-c
============

The `cert-flp37-c` check is an alias, please see
:doc:`bugprone-suspicious-memory-comparison <../bugprone/suspicious-memory-comparison>` for more information.
:doc:`bugprone-suspicious-memory-comparison
<../bugprone/suspicious-memory-comparison>` for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/mem57-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ cert-mem57-cpp
==============

The `cert-mem57-cpp` is an aliaes, please see
`bugprone-default-operator-new-on-overaligned-type <../bugprone/default-operator-new-on-overaligned-type.html>`_
`bugprone-default-operator-new-on-overaligned-type
<../bugprone/default-operator-new-on-overaligned-type.html>`_
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
12 changes: 6 additions & 6 deletions clang-tools-extra/docs/clang-tidy/checks/cert/msc50-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
cert-msc50-cpp
==============

Pseudorandom number generators use mathematical algorithms to produce a sequence
of numbers with good statistical properties, but the numbers produced are not
genuinely random. The ``std::rand()`` function takes a seed (number), runs a
mathematical operation on it and returns the result. By manipulating the seed
the result can be predictable. This check warns for the usage of
``std::rand()``.
Pseudorandom number generators use mathematical algorithms to produce a
sequence of numbers with good statistical properties, but the numbers
produced are not genuinely random. The ``std::rand()`` function takes a
seed (number), runs a mathematical operation on it and returns the result.
By manipulating the seed the result can be predictable. This check warns
for the usage of ``std::rand()``.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/msc51-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ cert-msc51-cpp
==============

The `cert-msc51-cpp` check is an alias, please see
:doc:`bugprone-random-generator-seed <../bugprone/random-generator-seed>`
:doc:`bugprone-random-generator-seed
<../bugprone/random-generator-seed>`
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/oop54-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ cert-oop54-cpp
==============

The `cert-oop54-cpp` check is an alias, please see
:doc:`bugprone-unhandled-self-assignment <../bugprone/unhandled-self-assignment>`
:doc:`bugprone-unhandled-self-assignment
<../bugprone/unhandled-self-assignment>`
for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/oop57-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ cert-oop57-cpp
==============

The `cert-oop57-cpp` check is an alias, please see
`bugprone-raw-memory-call-on-non-trivial-type <../bugprone/raw-memory-call-on-non-trivial-type.html>`_
`bugprone-raw-memory-call-on-non-trivial-type
<../bugprone/raw-memory-call-on-non-trivial-type.html>`_
for more information.

This check corresponds to the CERT C++ Coding Standard rule
Expand Down
5 changes: 3 additions & 2 deletions clang-tools-extra/docs/clang-tidy/checks/cert/oop58-cpp.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,6 @@ cert-oop58-cpp
==============

The `cert-oop58-cpp` check is an alias, please see
:doc:`bugprone-copy-constructor-mutates-argument <../bugprone/copy-constructor-mutates-argument>`
for more information.
:doc:`bugprone-copy-constructor-mutates-argument
<../bugprone/copy-constructor-mutates-argument>`
for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/pos44-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ cert-pos44-c
============

The `cert-pos44-c` check is an alias, please see
:doc:`bugprone-bad-signal-to-kill-thread <../bugprone/bad-signal-to-kill-thread>` for more information.
:doc:`bugprone-bad-signal-to-kill-thread
<../bugprone/bad-signal-to-kill-thread>` for more information.
3 changes: 2 additions & 1 deletion clang-tools-extra/docs/clang-tidy/checks/cert/pos47-c.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ cert-pos47-c
============

The `cert-pos47-c` check is an alias, please see
:doc:`concurrency-thread-canceltype-asynchronous <../concurrency/thread-canceltype-asynchronous>` for more information.
:doc:`concurrency-thread-canceltype-asynchronous
<../concurrency/thread-canceltype-asynchronous>` for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
clang-analyzer-security.SetgidSetuidOrder
=========================================

The checker checks for sequences of ``setuid(getuid())`` and ``setgid(getgid())``
calls (in this order). If such a sequence is found and there is no other
privilege-changing function call (``seteuid``, ``setreuid``, ``setresuid`` and
the GID versions of these) in between, a warning is generated. The checker finds
only exactly ``setuid(getuid())`` calls (and the GID versions), not for example
if the result of ``getuid()`` is stored in a variable.
The checker checks for sequences of ``setuid(getuid())`` and
``setgid(getgid())`` calls (in this order). If such a sequence is found and
there is no other privilege-changing function call (``seteuid``, ``setreuid``,
``setresuid`` and the GID versions of these) in between, a warning is
generated. The checker finds only exactly ``setuid(getuid())`` calls (and the
GID versions), not for example if the result of ``getuid()`` is stored in
a variable.

The `clang-analyzer-security.SetgidSetuidOrder` check is an alias, please see
`Clang Static Analyzer Available Checkers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@ clang-analyzer-security.insecureAPI.decodeValueOfObjCType

Warn on uses of the '-decodeValueOfObjCType:at:' method.

The clang-analyzer-security.insecureAPI.decodeValueOfObjCType check is an alias of
Clang Static Analyzer security.insecureAPI.decodeValueOfObjCType.
The clang-analyzer-security.insecureAPI.decodeValueOfObjCType
check is an alias of Clang Static Analyzer
security.insecureAPI.decodeValueOfObjCType.
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
clang-analyzer-unix.StdCLibraryFunctions
========================================

Check for invalid arguments of C standard library functions, and apply relations
between arguments and return value.
Check for invalid arguments of C standard library functions, and apply
relations between arguments and return value.

The `clang-analyzer-unix.StdCLibraryFunctions` check is an alias, please see
`Clang Static Analyzer Available Checkers
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
cppcoreguidelines-avoid-c-arrays
================================

The cppcoreguidelines-avoid-c-arrays check is an alias, please see
The `cppcoreguidelines-avoid-c-arrays` check is an alias, please see
:doc:`modernize-avoid-c-arrays <../modernize/avoid-c-arrays>`
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ This issue can occur even with refcounted smart pointers and copyable types.
When a lambda expression creates a coroutine, it results in a closure object
with storage, which is often on the stack and will eventually go out of scope.
When the closure object goes out of scope, its captures also go out of scope.
While normal lambdas finish executing before this happens, coroutine lambdas may
resume from suspension after the closure object has been destructed, resulting
in use-after-free memory access for all captures.
While normal lambdas finish executing before this happens, coroutine lambdas
may resume from suspension after the closure object has been destructed,
resulting in use-after-free memory access for all captures.

Consider the following example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,10 @@
cppcoreguidelines-avoid-do-while
================================

Warns when using ``do-while`` loops. They are less readable than plain ``while``
loops, since the termination condition is at the end and the condition is not
checked prior to the first iteration. This can lead to subtle bugs.
Warns when using ``do-while`` loops. They are less readable than plain
``while`` loops, since the termination condition is at the end and the
condition is not checked prior to the first iteration.
This can lead to subtle bugs.

This check implements `ES.75
<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Res-do>`_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
cppcoreguidelines-avoid-magic-numbers
=====================================

The cppcoreguidelines-avoid-magic-numbers check is an alias, please see
The `cppcoreguidelines-avoid-magic-numbers` check is an alias, please see
:doc:`readability-magic-numbers <../readability/magic-numbers>`
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@
cppcoreguidelines-avoid-reference-coroutine-parameters
======================================================

Warns when a coroutine accepts reference parameters. After a coroutine suspend point,
references could be dangling and no longer valid. Instead, pass parameters as values.
Warns when a coroutine accepts reference parameters. After a coroutine suspend
point, references could be dangling and no longer valid. Instead, pass
parameters as values.

Examples:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
cppcoreguidelines-c-copy-assignment-signature
=============================================

The `cppcoreguidelines-c-copy-assignment-signature` check is an alias, please see
:doc:`misc-unconventional-assign-operator <../misc/unconventional-assign-operator>`
for more information.
The `cppcoreguidelines-c-copy-assignment-signature` check is an alias,
please see :doc:`misc-unconventional-assign-operator
<../misc/unconventional-assign-operator>` for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@
cppcoreguidelines-explicit-virtual-functions
============================================

The `cppcoreguidelines-explicit-virtual-functions` check is an alias, please see
:doc:`modernize-use-override <../modernize/use-override>`
The `cppcoreguidelines-explicit-virtual-functions` check is an alias,
please see :doc:`modernize-use-override <../modernize/use-override>`
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,6 @@
cppcoreguidelines-macro-to-enum
===============================

The cppcoreguidelines-macro-to-enum check is an alias, please see
:doc:`modernize-macro-to-enum <../modernize/macro-to-enum>` for more information.
The `cppcoreguidelines-macro-to-enum` check is an alias, please see
:doc:`modernize-macro-to-enum <../modernize/macro-to-enum>`
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,6 @@ This check implements part of `ES.46
<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#es46-avoid-lossy-narrowing-truncating-arithmetic-conversions>`_
from the C++ Core Guidelines.

The cppcoreguidelines-narrowing-conversions check is an alias, please see
The `cppcoreguidelines-narrowing-conversions` check is an alias, please see
:doc:`bugprone-narrowing-conversions <../bugprone/narrowing-conversions>`
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ cppcoreguidelines-no-malloc
===========================

This check handles C-Style memory management using ``malloc()``, ``realloc()``,
``calloc()`` and ``free()``. It warns about its use and tries to suggest the use
of an appropriate RAII object.
Furthermore, it can be configured to check against a user-specified list of functions
that are used for memory management (e.g. ``posix_memalign()``).
``calloc()`` and ``free()``. It warns about its use and tries to suggest the
use of an appropriate RAII object.
Furthermore, it can be configured to check against a user-specified list of
functions that are used for memory management (e.g. ``posix_memalign()``).

This check implements `R.10
<https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rr-mallocfree>`_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ This check implements `C.66 <https://isocpp.github.io/CppCoreGuidelines/CppCoreG
from the C++ Core Guidelines.

The `cppcoreguidelines-noexcept-move-operations` check is an alias, please see
:doc:`performance-noexcept-move-constructor <../performance/noexcept-move-constructor>`
for more information.
:doc:`performance-noexcept-move-constructor
<../performance/noexcept-move-constructor>` for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
cppcoreguidelines-non-private-member-variables-in-classes
=========================================================

The cppcoreguidelines-non-private-member-variables-in-classes check is an alias,
please see
:doc:`misc-non-private-member-variables-in-classes <../misc/non-private-member-variables-in-classes>`
for more information.
The `cppcoreguidelines-non-private-member-variables-in-classes` check is
an alias, please see :doc:`misc-non-private-member-variables-in-classes
<../misc/non-private-member-variables-in-classes>` for more information.
Loading
Loading