[PATCH] D117939: [clang-tidy] Add more documentation about check development

[Eugene Zelenko via Phabricator via cfe-commits]

Eugene.Zelenko added a comment.

It's also make sense to mention `isLanguageVersionSupported`.



================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:79
+`Sphinx <https://www.sphinx-doc.org/en/master/>`_ and enable it in the CMake configuration.
+To save build time of the core clang libraries you may want to only enable the ``X86``
+target in the CMake configuration.
----------------
Clang.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:232
+
+
+Check development tips
----------------
Excessive newline.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:237
+Writing your first check can be a daunting task, particularly if you are unfamiliar
+with the LLVM and clang code bases.  Here are some suggestions for orienting yourself
+in the codebase and working on your check incrementally.
----------------
Clang.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:243
+
+Many of the support classes created for LLVM are used by clang, such as `StringRef
+<https://llvm.org/docs/ProgrammersManual.html#the-stringref-class>`_
----------------
Clang.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:265
+<https://clang.llvm.org/docs/InternalsManual.html>`_.  Whereas the doxygen generated
+documentation serves as a reference to the internals of clang, this document serves
+as a guide to other developers.  Topics in that manual of interest to a check developer
----------------
Clang.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:339
+can help you understand a complicated matcher.  Once you have a working matcher, the
+C++ api will be virtually identical to your interactively constructed matcher.  You can
+use local variables to preserve your intention revealing names that you applied to
----------------
API.


================
Comment at: clang-tools-extra/docs/clang-tidy/Contributing.rst:385
+
+The ``add_new_check.py`` script creates entries in the release notes, the list of
+checks and a new file for the check documentation itself.  It is recommended that you
----------------
Link to Release Notes?


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

https://reviews.llvm.org/D117939