Author: mitchell Date: 2025-12-17T01:09:25+08:00 New Revision: 1bd0ec432ff4693645e9e45d132ab8cb7dea694c
URL: https://github.com/llvm/llvm-project/commit/1bd0ec432ff4693645e9e45d132ab8cb7dea694c DIFF: https://github.com/llvm/llvm-project/commit/1bd0ec432ff4693645e9e45d132ab8cb7dea694c.diff LOG: [clang-tidy][NFC] Add `doc8` documentations (#167269) This is part of the documentation improvement discussed in #167098 --------- Co-authored-by: Baranov Victor <[email protected]> Added: Modified: clang-tools-extra/docs/clang-tidy/Contributing.rst Removed: ################################################################################ diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst index 4ede4ea36c13d..69be01c206222 100644 --- a/clang-tools-extra/docs/clang-tidy/Contributing.rst +++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst @@ -449,7 +449,22 @@ Building the target ``docs-clang-tools-html`` will run the Sphinx documentation and create HTML documentation files in the tools/clang/tools/extra/docs/html directory in your build tree. Make sure that your check is correctly shown in the release notes and the list of checks. Make sure that the formatting and structure of your check's documentation -look correct. +look correct: there is no trailing whitespaces and lines are no longer than 80 characters. + +To validate your files, please use ``doc8`` as described below. + +Clang-Tidy uses `doc8 <https://pypi.org/project/doc8/>`_ to check ``.rst`` +files for formatting consistency. You can install ``doc8`` with ``pip``: + +.. code-block:: console + + $ pip install doc8 + +To run ``doc8`` on the modified documentations: + +.. code-block:: console + + $ git diff --name-only HEAD -- clang-tools-extra/docs/clang-tidy/ | grep "\.rst$" | xargs -r doc8 Registering your Check @@ -814,4 +829,4 @@ There is only one argument that controls profile storage: * If you run :program:`clang-tidy` from within ``/foo`` directory, and specify ``-store-check-profile=.``, then the profile will still be saved to - ``/foo/<ISO8601-like timestamp>-example.cpp.json`` \ No newline at end of file + ``/foo/<ISO8601-like timestamp>-example.cpp.json`` _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
