Skip to content

Commit

Permalink
[clang-tidy][NFC] Update documentation for Clang Static Analyzer aliases
Browse files Browse the repository at this point in the history
Update documentation by using gen-static-analyzer-docs.py.
All  Clang Static Analyzer checks are now listed as aliases.
Check without documentation wont have a link.

Fixes: #41439
  • Loading branch information
PiotrZSL committed Aug 11, 2023
1 parent 5568f28 commit d9cd7b0
Show file tree
Hide file tree
Showing 94 changed files with 527 additions and 90 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
clang-analyzer-core.CallAndMessage
==================================

Check for logical errors for function calls and Objective-C message expressions
(e.g., uninitialized arguments, null function pointers).

The clang-analyzer-core.CallAndMessage check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-callandmessage>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-callandmessage>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.DivideZero
==============================

Check for division by zero.

The clang-analyzer-core.DivideZero check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-dividezero>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-dividezero>`_
for more information.

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
clang-analyzer-core.NonNullParamChecker
=======================================

Check for null pointers passed as arguments to a function whose arguments are
references or marked with the 'nonnull' attribute.

The clang-analyzer-core.NonNullParamChecker check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-nonnullparamchecker>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-nonnullparamchecker>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.NullDereference
===================================

Check for dereferences of null pointers.

The clang-analyzer-core.NullDereference check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-nulldereference>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-nulldereference>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.StackAddressEscape
======================================

Check that addresses to stack memory do not escape the function.

The clang-analyzer-core.StackAddressEscape check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-stackaddressescape>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-stackaddressescape>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.UndefinedBinaryOperatorResult
=================================================

Check for undefined results of binary operators.

The clang-analyzer-core.UndefinedBinaryOperatorResult check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-undefinedbinaryoperatorresult>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-undefinedbinaryoperatorresult>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.VLASize
===========================

Check for declarations of VLA of undefined or zero size.

The clang-analyzer-core.VLASize check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-vlasize>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-vlasize>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.uninitialized.ArraySubscript
================================================

Check for uninitialized values used as array subscripts.

The clang-analyzer-core.uninitialized.ArraySubscript check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-arraysubscript>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-arraysubscript>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.uninitialized.Assign
========================================

Check for assigning uninitialized values.

The clang-analyzer-core.uninitialized.Assign check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-assign>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-assign>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.uninitialized.Branch
========================================

Check for uninitialized values used as branch conditions.

The clang-analyzer-core.uninitialized.Branch check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-branch>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-branch>`_
for more information.
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
.. title:: clang-tidy - clang-analyzer-core.uninitialized.CapturedBlockVariable
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-capturedblockvariable

clang-analyzer-core.uninitialized.CapturedBlockVariable
=======================================================

Check for blocks that capture uninitialized values
Check for blocks that capture uninitialized values.

The clang-analyzer-core.uninitialized.CapturedBlockVariable check is an alias, please see
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-capturedblockvariable>`_
for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. title:: clang-tidy - clang-analyzer-core.uninitialized.NewArraySize
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-newarraysize

clang-analyzer-core.uninitialized.NewArraySize
==============================================

Check if the size of the array in a new[] expression is undefined.

The clang-analyzer-core.uninitialized.NewArraySize check is an alias, please see
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-newarraysize>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-core.uninitialized.UndefReturn
=============================================

Check for uninitialized values being returned to the caller.

The clang-analyzer-core.uninitialized.UndefReturn check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-undefreturn>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#core-uninitialized-undefreturn>`_
for more information.
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
.. title:: clang-tidy - clang-analyzer-cplusplus.InnerPointer
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-innerpointer

clang-analyzer-cplusplus.InnerPointer
=====================================

Check for inner pointers of C++ containers used after re/deallocation
Check for inner pointers of C++ containers used after re/deallocation.

The clang-analyzer-cplusplus.InnerPointer check is an alias, please see
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-innerpointer>`_
for more information.
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
.. title:: clang-tidy - clang-analyzer-cplusplus.Move
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-move

clang-analyzer-cplusplus.Move
=============================

The clang-analyzer-cplusplus.Move check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-move>`_
for more information.
Find use-after-move bugs in C++.

The clang-analyzer-cplusplus.Move check is an alias of
Clang Static Analyzer cplusplus.Move.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
clang-analyzer-cplusplus.NewDelete
==================================

Check for double-free and use-after-free problems. Traces memory managed by
new/delete.

The clang-analyzer-cplusplus.NewDelete check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-newdelete>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-newdelete>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-cplusplus.NewDeleteLeaks
=======================================

Check for memory leaks. Traces memory managed by new/delete.

The clang-analyzer-cplusplus.NewDeleteLeaks check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-newdeleteleaks>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-newdeleteleaks>`_
for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. title:: clang-tidy - clang-analyzer-cplusplus.PlacementNew

clang-analyzer-cplusplus.PlacementNew
=====================================

Check if default placement new is provided with pointers to sufficient storage
capacity.

The clang-analyzer-cplusplus.PlacementNew check is an alias of
Clang Static Analyzer cplusplus.PlacementNew.
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. title:: clang-tidy - clang-analyzer-cplusplus.PureVirtualCall

clang-analyzer-cplusplus.PureVirtualCall
========================================

Check pure virtual function calls during construction/destruction.

The clang-analyzer-cplusplus.PureVirtualCall check is an alias of
Clang Static Analyzer cplusplus.PureVirtualCall.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. title:: clang-tidy - clang-analyzer-cplusplus.StringChecker
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-stringchecker

clang-analyzer-cplusplus.StringChecker
======================================

Checks C++ std::string bugs.

The clang-analyzer-cplusplus.StringChecker check is an alias, please see
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#cplusplus-stringchecker>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-deadcode.DeadStores
==================================

Check for values stored to variables that are never read afterwards.

The clang-analyzer-deadcode.DeadStores check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#deadcode-deadstores>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#deadcode-deadstores>`_
for more information.
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
.. title:: clang-tidy - clang-analyzer-fuchsia.HandleChecker
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#fuchsia-handlechecker

clang-analyzer-fuchsia.HandleChecker
====================================

A Checker that detect leaks related to Fuchsia handles.

The clang-analyzer-fuchsia.HandleChecker check is an alias, please see
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#fuchsia-handlechecker>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-nullability.NullPassedToNonnull
==============================================

Warns when a null pointer is passed to a pointer which has a _Nonnull type.

The clang-analyzer-nullability.NullPassedToNonnull check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullpassedtononnull>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullpassedtononnull>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
clang-analyzer-nullability.NullReturnedFromNonnull
==================================================

Warns when a null pointer is returned from a function that has _Nonnull return
type.

The clang-analyzer-nullability.NullReturnedFromNonnull check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullreturnedfromnonnull>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullreturnedfromnonnull>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-nullability.NullableDereferenced
===============================================

Warns when a nullable pointer is dereferenced.

The clang-analyzer-nullability.NullableDereferenced check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullabledereferenced>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullabledereferenced>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-nullability.NullablePassedToNonnull
==================================================

Warns when a nullable pointer is passed to a pointer which has a _Nonnull type.

The clang-analyzer-nullability.NullablePassedToNonnull check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullablepassedtononnull>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullablepassedtononnull>`_
for more information.
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
.. title:: clang-tidy - clang-analyzer-nullability.NullableReturnedFromNonnull
.. meta::
:http-equiv=refresh: 5;URL=https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullablereturnedfromnonnull

clang-analyzer-nullability.NullableReturnedFromNonnull
======================================================

Warns when a nullable pointer is returned from a function that has _Nonnull return type.
Warns when a nullable pointer is returned from a function that has _Nonnull
return type.

The clang-analyzer-nullability.NullableReturnedFromNonnull check is an alias, please see
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#nullability-nullablereturnedfromnonnull>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-optin.cplusplus.UninitializedObject
==================================================

Reports uninitialized fields after object construction.

The clang-analyzer-optin.cplusplus.UninitializedObject check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#optin-cplusplus-uninitializedobject>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#optin-cplusplus-uninitializedobject>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-optin.cplusplus.VirtualCall
==========================================

Check virtual function calls during construction/destruction.

The clang-analyzer-optin.cplusplus.VirtualCall check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#optin-cplusplus-virtualcall>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#optin-cplusplus-virtualcall>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-optin.mpi.MPI-Checker
====================================

Checks MPI code.

The clang-analyzer-optin.mpi.MPI-Checker check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#optin-mpi-mpi-checker>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#optin-mpi-mpi-checker>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,7 @@
clang-analyzer-optin.osx.OSObjectCStyleCast
===========================================

Checker for C-style casts of OSObjects
Checker for C-style casts of OSObjects.

The clang-analyzer-optin.osx.OSObjectCStyleCast check is an alias of
Clang Static Analyzer optin.osx.OSObjectCStyleCast.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
clang-analyzer-optin.osx.cocoa.localizability.EmptyLocalizationContextChecker
=============================================================================

Check that NSLocalizedString macros include a comment for context.

The clang-analyzer-optin.osx.cocoa.localizability.EmptyLocalizationContextChecker check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#optin-osx-cocoa-localizability-emptylocalizationcontextchecker>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#optin-osx-cocoa-localizability-emptylocalizationcontextchecker>`_
for more information.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@
clang-analyzer-optin.osx.cocoa.localizability.NonLocalizedStringChecker
=======================================================================

Warns about uses of non-localized NSStrings passed to UI methods expecting
localized NSStrings.

The clang-analyzer-optin.osx.cocoa.localizability.NonLocalizedStringChecker check is an alias, please see
`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html#optin-osx-cocoa-localizability-nonlocalizedstringchecker>`_
`Clang Static Analyzer Available Checkers
<https://clang.llvm.org/docs/analyzer/checkers.html#optin-osx-cocoa-localizability-nonlocalizedstringchecker>`_
for more information.

0 comments on commit d9cd7b0

Please sign in to comment.