[PATCH] D64454: [clang-tidy] Adding static analyzer check to list of clang-tidy checks

Aaron Ballman via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Thu Jul 11 08:40:04 PDT 2019


aaron.ballman added inline comments.


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/gen-static-analyzer-docs.py:2-3
+"""
+Generates documentation based off the available static analyzers checks
+References Checkers.td to determine what checks exist
+"""
----------------
Add full stops to the end of the sentences.


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/gen-static-analyzer-docs.py:6
+
+checkers_td_directory = "../../../../clang/include/clang/StaticAnalyzer/Checkers/"
+
----------------
Will this work with the monorepo layout?


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/gen-static-analyzer-docs.py:12
+
+"""Get path of script so files are always in correct directory"""
+__location__ = os.path.realpath(
----------------
path -> the path
correct -> the correct

Add a full stop to the end of the comment. (Please check the other comments in the file as well.)


================
Comment at: clang-tools-extra/docs/clang-tidy/checks/gen-static-analyzer-docs.py:73
+      f.write("The %s check is an alias, please see\n" % checker["FullPackageName"])
+      f.write("`Clang Static Analyzer Available Checkers <https://clang.llvm.org/docs/analyzer/checkers.html>`_\n")
+      f.write("for more information.\n")
----------------
Is there a way we can automatically link directly to the proper anchor instead of the general checker page?


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D64454/new/

https://reviews.llvm.org/D64454





More information about the cfe-commits mailing list