[all-commits] [llvm/llvm-project] 5568f2: [clang-tidy][NFC] Update gen-static-analyzer-docs.py

Piotr Zegar via All-commits all-commits at lists.llvm.org
Fri Aug 11 03:38:03 PDT 2023


  Branch: refs/heads/main
  Home:   https://github.com/llvm/llvm-project
  Commit: 5568f28c868eb13033d64189560ee0e62d745285
      https://github.com/llvm/llvm-project/commit/5568f28c868eb13033d64189560ee0e62d745285
  Author: Piotr Zegar <me at piotrzegar.pl>
  Date:   2023-08-11 (Fri, 11 Aug 2023)

  Changed paths:
    M clang-tools-extra/docs/clang-tidy/checks/gen-static-analyzer-docs.py

  Log Message:
  -----------
  [clang-tidy][NFC] Update gen-static-analyzer-docs.py

Update gen-static-analyzer-docs.py to generate more proper documentation
for Clang Static Analyzer checkers.

Fixes: #43715


  Commit: d9cd7b0e5f347fb316c6efa075d009a003c8fc54
      https://github.com/llvm/llvm-project/commit/d9cd7b0e5f347fb316c6efa075d009a003c8fc54
  Author: Piotr Zegar <me at piotrzegar.pl>
  Date:   2023-08-11 (Fri, 11 Aug 2023)

  Changed paths:
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.CallAndMessage.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.DivideZero.rst
    R clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.DynamicTypePropagation.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.NonNullParamChecker.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.NullDereference.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.StackAddressEscape.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.UndefinedBinaryOperatorResult.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.VLASize.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.uninitialized.ArraySubscript.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.uninitialized.Assign.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.uninitialized.Branch.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.uninitialized.CapturedBlockVariable.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.uninitialized.NewArraySize.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/core.uninitialized.UndefReturn.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.InnerPointer.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.Move.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.NewDelete.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.NewDeleteLeaks.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.PlacementNew.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.PureVirtualCall.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/cplusplus.StringChecker.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/deadcode.DeadStores.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/fuchsia.HandleChecker.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/nullability.NullPassedToNonnull.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/nullability.NullReturnedFromNonnull.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/nullability.NullableDereferenced.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/nullability.NullablePassedToNonnull.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/nullability.NullableReturnedFromNonnull.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.cplusplus.UninitializedObject.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.cplusplus.VirtualCall.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.mpi.MPI-Checker.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.osx.OSObjectCStyleCast.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.osx.cocoa.localizability.EmptyLocalizationContextChecker.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.osx.cocoa.localizability.NonLocalizedStringChecker.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.performance.GCDAntipattern.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.performance.Padding.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/optin.portability.UnixAPI.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.API.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.MIG.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.NumberObjectConversion.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.OSObjectRetainCount.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.ObjCProperty.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.SecKeychainAPI.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.AtSync.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.AutoreleaseWrite.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.ClassRelease.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.Dealloc.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.IncompatibleMethodTypes.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.Loops.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.MissingSuperCall.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.NSAutoreleasePool.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.NSError.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.NilArg.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.NonNilReturnValue.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.ObjCGenerics.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.RetainCount.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.RunLoopAutoreleaseLeak.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.SelfInit.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.SuperDealloc.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.UnusedIvars.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.cocoa.VariadicMethodTypes.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.coreFoundation.CFError.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.coreFoundation.CFNumber.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.coreFoundation.CFRetainRelease.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.coreFoundation.containers.OutOfBounds.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/osx.coreFoundation.containers.PointerSizedValues.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.FloatLoopCounter.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.DeprecatedOrUnsafeBufferHandling.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.UncheckedReturn.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.bcmp.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.bcopy.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.bzero.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.decodeValueOfObjCType.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.getpw.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.gets.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.mkstemp.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.mktemp.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.rand.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.strcpy.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/security.insecureAPI.vfork.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.API.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.Malloc.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.MallocSizeof.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.MismatchedDeallocator.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.Vfork.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.cstring.BadSizeArg.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/unix.cstring.NullArg.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/valist.CopyToSelf.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/valist.Uninitialized.rst
    M clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/valist.Unterminated.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/webkit.NoUncountedMemberChecker.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/webkit.RefCntblBaseVirtualDtor.rst
    A clang-tools-extra/docs/clang-tidy/checks/clang-analyzer/webkit.UncountedLambdaCapturesChecker.rst
    M clang-tools-extra/docs/clang-tidy/checks/list.rst

  Log Message:
  -----------
  [clang-tidy][NFC] Update documentation for Clang Static Analyzer aliases

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


Compare: https://github.com/llvm/llvm-project/compare/f36e909da037...d9cd7b0e5f34


More information about the All-commits mailing list