https://github.com/zeyi2 updated https://github.com/llvm/llvm-project/pull/172123
>From 4b0b1ee150ea820f00564667e734ddd225665d53 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Fri, 12 Dec 2025 22:39:40 +0800 Subject: [PATCH 01/27] [Github][CI] Introduce `doc8` to `code-lint-helper.py` --- .../github-action-ci-tooling/Dockerfile | 5 +- .github/workflows/pr-code-lint.yml | 6 +- llvm/utils/git/code-lint-helper.py | 61 ++++++++++++++++++- 3 files changed, 67 insertions(+), 5 deletions(-) diff --git a/.github/workflows/containers/github-action-ci-tooling/Dockerfile b/.github/workflows/containers/github-action-ci-tooling/Dockerfile index b78c99efb9be3..47dedba5194e2 100644 --- a/.github/workflows/containers/github-action-ci-tooling/Dockerfile +++ b/.github/workflows/containers/github-action-ci-tooling/Dockerfile @@ -94,6 +94,10 @@ COPY --from=llvm-downloader /llvm-extract/LLVM-${LLVM_VERSION}-Linux-X64/bin/cla COPY clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py ${LLVM_SYSROOT}/bin/clang-tidy-diff.py # Install dependencies for 'pr-code-lint.yml' job +RUN apt-get update && \ + DEBIAN_FRONTEND=noninteractive apt-get install -y python3-doc8 && \ + apt-get clean && \ + rm -rf /var/lib/apt/lists/* COPY llvm/utils/git/requirements_linting.txt requirements_linting.txt RUN pip install -r requirements_linting.txt --break-system-packages && \ rm requirements_linting.txt @@ -119,4 +123,3 @@ RUN git clone https://github.com/universal-ctags/ctags.git && \ ./configure && \ sudo make install && \ rm -Rf ../ctags - diff --git a/.github/workflows/pr-code-lint.yml b/.github/workflows/pr-code-lint.yml index ea4f8217cd003..ed0b371064b80 100644 --- a/.github/workflows/pr-code-lint.yml +++ b/.github/workflows/pr-code-lint.yml @@ -20,7 +20,7 @@ jobs: run: shell: bash container: - image: 'ghcr.io/llvm/ci-ubuntu-24.04-lint' + image: 'ghcr.io/llvm/ci-ubuntu-24.04-lint-doc8' timeout-minutes: 60 concurrency: group: ${{ github.workflow }}-${{ github.ref }} @@ -71,12 +71,12 @@ jobs: -DLLVM_INCLUDE_TESTS=OFF \ -DCLANG_INCLUDE_TESTS=OFF \ -DCMAKE_BUILD_TYPE=Release - + ninja -C build \ clang-tablegen-targets \ genconfusable # for "ConfusableIdentifierCheck.h" - - name: Run code linter + - name: Run code linters env: GITHUB_PR_NUMBER: ${{ github.event.pull_request.number }} CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }} diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index a53549fb69a77..aca88e2be5a8c 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -36,6 +36,7 @@ class LintArgs: issue_number: int = 0 build_path: str = "build" clang_tidy_binary: str = "clang-tidy" + doc8_binary: str = "doc8" def __init__(self, args: argparse.Namespace) -> None: if args is not None: @@ -50,6 +51,7 @@ def __init__(self, args: argparse.Namespace) -> None: self.verbose = args.verbose self.build_path = args.build_path self.clang_tidy_binary = args.clang_tidy_binary + self.doc8_binary = args.doc8_binary class LintHelper: @@ -289,8 +291,59 @@ def _clean_clang_tidy_output(self, output: str) -> str: return "" +class Doc8LintHelper(LintHelper): + name: Final = "doc8" + friendly_name: Final = "documentation linter" -ALL_LINTERS = (ClangTidyLintHelper(),) + def instructions(self, files_to_lint: Sequence[str], args: LintArgs) -> str: + files_str = " ".join(files_to_lint) + return f"doc8 -q {files_str}" + + def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: + filtered_files = [] + for filepath in changed_files: + _, ext = os.path.splitext(filepath) + if ext != ".rst": + continue + if not filepath.startswith("clang-tools-extra/docs/clang-tidy/"): + continue + if os.path.exists(filepath): + filtered_files.append(filepath) + return filtered_files + + def run_linter_tool(self, files_to_lint: Sequence[str], args: LintArgs) -> str: + if not files_to_lint: + return "" + + doc8_cmd = [args.doc8_binary, "-q"] + doc8_cmd.extend(files_to_lint) + + if args.verbose: + print(f"Running doc8: {' '.join(doc8_cmd)}") + + proc = subprocess.run( + doc8_cmd, + stdout=subprocess.PIPE, + stderr=subprocess.PIPE, + text=True, + check=False, + ) + + if proc.returncode == 0: + return "" + + output = proc.stdout.strip() + if output: + return output + + error_output = proc.stderr.strip() + if error_output: + return error_output + + return f"doc8 exited with return code {proc.returncode} but no output." + + +ALL_LINTERS = (ClangTidyLintHelper(), Doc8LintHelper()) if __name__ == "__main__": @@ -331,6 +384,12 @@ def _clean_clang_tidy_output(self, output: str) -> str: default="clang-tidy", help="Path to clang-tidy binary", ) + parser.add_argument( + "--doc8-binary", + type=str, + default="doc8", + help="Path to doc8 binary", + ) parser.add_argument( "--verbose", action="store_true", default=True, help="Verbose output" ) >From d5f45bb1c2d7deed3eb3ed23f0a18cba6e008706 Mon Sep 17 00:00:00 2001 From: mitchell <[email protected]> Date: Sat, 13 Dec 2025 20:39:00 +0800 Subject: [PATCH 02/27] Apply suggestions from code review Co-authored-by: EugeneZelenko <[email protected]> --- llvm/utils/git/code-lint-helper.py | 15 ++++++--------- 1 file changed, 6 insertions(+), 9 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index aca88e2be5a8c..aabc78f2de033 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -295,11 +295,10 @@ class Doc8LintHelper(LintHelper): name: Final = "doc8" friendly_name: Final = "documentation linter" - def instructions(self, files_to_lint: Sequence[str], args: LintArgs) -> str: - files_str = " ".join(files_to_lint) - return f"doc8 -q {files_str}" + def instructions(self, files_to_lint: Iterable[str], args: LintArgs) -> str: + return f"doc8 -q {' '.join(files_to_lint)}" - def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: + def filter_changed_files(self, changed_files: Iterable[str]) -> Sequence[str]: filtered_files = [] for filepath in changed_files: _, ext = os.path.splitext(filepath) @@ -311,7 +310,7 @@ def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: filtered_files.append(filepath) return filtered_files - def run_linter_tool(self, files_to_lint: Sequence[str], args: LintArgs) -> str: + def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if not files_to_lint: return "" @@ -332,12 +331,10 @@ def run_linter_tool(self, files_to_lint: Sequence[str], args: LintArgs) -> str: if proc.returncode == 0: return "" - output = proc.stdout.strip() - if output: + if output := proc.stdout.strip(): return output - error_output = proc.stderr.strip() - if error_output: + if error_output := proc.stderr.strip(): return error_output return f"doc8 exited with return code {proc.returncode} but no output." >From e014eb29350befe49cd99d131f414661d88e3539 Mon Sep 17 00:00:00 2001 From: mitchell <[email protected]> Date: Sat, 13 Dec 2025 20:48:40 +0800 Subject: [PATCH 03/27] Update llvm/utils/git/code-lint-helper.py Co-authored-by: Baranov Victor <[email protected]> --- llvm/utils/git/code-lint-helper.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index aabc78f2de033..db551204f0c1a 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -293,7 +293,7 @@ def _clean_clang_tidy_output(self, output: str) -> str: class Doc8LintHelper(LintHelper): name: Final = "doc8" - friendly_name: Final = "documentation linter" + friendly_name: Final = "RST documentation linter" def instructions(self, files_to_lint: Iterable[str], args: LintArgs) -> str: return f"doc8 -q {' '.join(files_to_lint)}" >From 1188b8dbe36b8cfada478cfa3f3f9e25c3b6c18f Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sat, 13 Dec 2025 20:45:35 +0800 Subject: [PATCH 04/27] Fix --- llvm/utils/git/code-lint-helper.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index db551204f0c1a..3947bcac7f3b9 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -23,7 +23,7 @@ import os import subprocess import sys -from typing import Any, Dict, Final, List, Sequence +from typing import Any, Dict, Final, Iterable, List, Sequence class LintArgs: @@ -194,7 +194,7 @@ def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: arg for arg in changed_files if "third-party" not in arg ] - filtered_files = [] + filtered_files: List[str] = [] for filepath in clang_tidy_changed_files: _, ext = os.path.splitext(filepath) if ext not in (".c", ".cpp", ".cxx", ".h", ".hpp", ".hxx"): @@ -298,8 +298,8 @@ class Doc8LintHelper(LintHelper): def instructions(self, files_to_lint: Iterable[str], args: LintArgs) -> str: return f"doc8 -q {' '.join(files_to_lint)}" - def filter_changed_files(self, changed_files: Iterable[str]) -> Sequence[str]: - filtered_files = [] + def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: + filtered_files: List[str] = [] for filepath in changed_files: _, ext = os.path.splitext(filepath) if ext != ".rst": >From 03ae3744662c985472aedc387407f7ff5a11194d Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sat, 13 Dec 2025 20:58:15 +0800 Subject: [PATCH 05/27] Split filter function and refactor error handling --- llvm/utils/git/code-lint-helper.py | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index 3947bcac7f3b9..d89a1e259ed3a 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -304,12 +304,15 @@ def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: _, ext = os.path.splitext(filepath) if ext != ".rst": continue - if not filepath.startswith("clang-tools-extra/docs/clang-tidy/"): + if not self._should_lint_file(filepath): continue if os.path.exists(filepath): filtered_files.append(filepath) return filtered_files + def _should_lint_file(self, filepath: str) -> bool: + return filepath.startswith("clang-tools-extra/docs/clang-tidy/") + def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if not files_to_lint: return "" @@ -331,13 +334,19 @@ def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if proc.returncode == 0: return "" - if output := proc.stdout.strip(): - return output + output = proc.stdout.strip() + error_output = proc.stderr.strip() - if error_output := proc.stderr.strip(): - return error_output + parts: List[str] = [] + if output: + parts.append(output) + if error_output: + parts.append(f"stderr:\n{error_output}") - return f"doc8 exited with return code {proc.returncode} but no output." + if parts: + return "\n\n".join(parts) + else: + return f"doc8 exited with return code {proc.returncode} but no output." ALL_LINTERS = (ClangTidyLintHelper(), Doc8LintHelper()) >From 5661fef3bc4a93986c3cd64b40547a864300afa6 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 13:39:14 +0800 Subject: [PATCH 06/27] Fix EOF --- .../workflows/containers/github-action-ci-tooling/Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/containers/github-action-ci-tooling/Dockerfile b/.github/workflows/containers/github-action-ci-tooling/Dockerfile index ba49c1cbfa245..6ac090e9a3385 100644 --- a/.github/workflows/containers/github-action-ci-tooling/Dockerfile +++ b/.github/workflows/containers/github-action-ci-tooling/Dockerfile @@ -116,4 +116,4 @@ RUN apt-get update && \ pkg-config \ universal-ctags && \ apt-get clean && \ - rm -rf /var/lib/apt/lists/* \ No newline at end of file + rm -rf /var/lib/apt/lists/* >From 89bf56774b92fde5ef78c3b7cb032487236b9d0f Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 13:44:43 +0800 Subject: [PATCH 07/27] test `doc8` linting --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index cb7ea415c54b2..4ecae979831a6 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -23,7 +23,7 @@ The following functions are reported if :option:`ReportDefaultFunctions` is enabled. If *Annex K.* is available, a replacement from *Annex K.* is suggested for the -following functions: +following functions ``asctime``, ``asctime_r``, ``bsearch``, ``ctime``, ``fopen``, ``fprintf``, ``freopen``, ``fscanf``, ``fwprintf``, ``fwscanf``, ``getenv``, ``gets``, >From 472af3792b7b5e0c58f5eb98d0c1809a2f56f6c4 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 13:56:14 +0800 Subject: [PATCH 08/27] Test doc update --- .../checks/bugprone/unsafe-functions.rst | 31 ++++++++++--------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 4ecae979831a6..27909ca329df8 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -23,7 +23,7 @@ The following functions are reported if :option:`ReportDefaultFunctions` is enabled. If *Annex K.* is available, a replacement from *Annex K.* is suggested for the -following functions +following functions: ``asctime``, ``asctime_r``, ``bsearch``, ``ctime``, ``fopen``, ``fprintf``, ``freopen``, ``fscanf``, ``fwprintf``, ``fwscanf``, ``getenv``, ``gets``, @@ -96,21 +96,22 @@ to be checked. The format is the following, without newlines: The functions are matched using POSIX extended regular expressions. *(Note: The regular expressions do not support negative* ``(?!)`` *matches.)* -The ``reason`` is optional and is used to provide additional information about the -reasoning behind the replacement. The default reason is ``is marked as unsafe``. +The ``reason`` is optional and is used to provide additional information about +the reasoning behind the replacement. The default reason is +``is marked as unsafe``. If ``replacement`` is empty, the default text ``it should not be used`` will be shown instead of the suggestion for a replacement. -If the ``reason`` starts with the character ``>``, the reason becomes fully custom. -The default suffix is disabled even if a ``replacement`` is present, and only the -reason message is shown after the matched function, to allow better control over -the suggestions. (The starting ``>`` and whitespace directly after it are -trimmed from the message.) +If the ``reason`` starts with the character ``>``, the reason becomes fully +custom. The default suffix is disabled even if a ``replacement`` is present, +and only the reason message is shown after the matched function, to allow +better control over the suggestions. (The starting ``>`` and whitespace +directly after it are trimmed from the message.) -As an example, the following configuration matches only the function ``original`` -in the default namespace. A similar diagnostic can also be printed using a fully -custom reason. +As an example, the following configuration matches only the function +``original`` in the default namespace. A similar diagnostic can also be +printed using a fully custom reason. .. code:: c @@ -123,10 +124,10 @@ custom reason. ::std::original(); // no-warning original_function(); // no-warning -If the regular expression contains the character ``:``, it is matched against the -qualified name (i.e. ``std::original``), otherwise the regex is matched against -the unqualified name (``original``). If the regular expression starts with ``::`` -(or ``^::``), it is matched against the fully qualified name +If the regular expression contains the character ``:``, it is matched against +the qualified name (i.e. ``std::original``), otherwise the regex is matched +against the unqualified name (``original``). If the regular expression starts +with ``::`` (or ``^::``), it is matched against the fully qualified name (``::std::original``). One of the use cases for fully custom messages is suggesting compiler options >From 702005aa818993050aae4e9fafde561d18152a13 Mon Sep 17 00:00:00 2001 From: mitchell <[email protected]> Date: Sun, 14 Dec 2025 14:05:08 +0800 Subject: [PATCH 09/27] Apply suggestions from code review Co-authored-by: EugeneZelenko <[email protected]> --- llvm/utils/git/code-lint-helper.py | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index d89a1e259ed3a..8d97f99dc8f4a 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -298,7 +298,7 @@ class Doc8LintHelper(LintHelper): def instructions(self, files_to_lint: Iterable[str], args: LintArgs) -> str: return f"doc8 -q {' '.join(files_to_lint)}" - def filter_changed_files(self, changed_files: Sequence[str]) -> Sequence[str]: + def filter_changed_files(self, changed_files: Iterable[str]) -> Sequence[str]: filtered_files: List[str] = [] for filepath in changed_files: _, ext = os.path.splitext(filepath) @@ -345,8 +345,7 @@ def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if parts: return "\n\n".join(parts) - else: - return f"doc8 exited with return code {proc.returncode} but no output." + return f"doc8 exited with return code {proc.returncode} but no output." ALL_LINTERS = (ClangTidyLintHelper(), Doc8LintHelper()) >From 242834036ca2cb5321f3f29aafc10a1467fd847d Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 14:13:53 +0800 Subject: [PATCH 10/27] Fix style issues --- llvm/utils/git/code-lint-helper.py | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index 8d97f99dc8f4a..b2ab101e6d1b9 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -299,19 +299,14 @@ def instructions(self, files_to_lint: Iterable[str], args: LintArgs) -> str: return f"doc8 -q {' '.join(files_to_lint)}" def filter_changed_files(self, changed_files: Iterable[str]) -> Sequence[str]: - filtered_files: List[str] = [] - for filepath in changed_files: - _, ext = os.path.splitext(filepath) - if ext != ".rst": - continue - if not self._should_lint_file(filepath): - continue - if os.path.exists(filepath): - filtered_files.append(filepath) - return filtered_files + return list(filter(self._should_lint_file, changed_files)) def _should_lint_file(self, filepath: str) -> bool: - return filepath.startswith("clang-tools-extra/docs/clang-tidy/") + return ( + os.path.splitext(filepath)[1] == ".rst" + and filepath.startswith("clang-tools-extra/docs/clang-tidy/") + and os.path.exists(filepath) + ) def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if not files_to_lint: @@ -334,13 +329,10 @@ def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if proc.returncode == 0: return "" - output = proc.stdout.strip() - error_output = proc.stderr.strip() - parts: List[str] = [] - if output: + if output := proc.stdout.strip(): parts.append(output) - if error_output: + if error_output := proc.stderr.strip(): parts.append(f"stderr:\n{error_output}") if parts: >From af21767e1cb748412d595d6374aa1db82fc2924b Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 14:16:21 +0800 Subject: [PATCH 11/27] Test again --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 27909ca329df8..864a9d1931332 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -3,8 +3,7 @@ bugprone-unsafe-functions ========================= -Checks for functions that have safer, more secure replacements available, or -are considered deprecated due to design flaws. +Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. The check heavily relies on the functions from the **Annex K.** "Bounds-checking interfaces" of C11. >From d3bdea8d506c17a0fc3b37feed580f9209a18b48 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 14:52:40 +0800 Subject: [PATCH 12/27] Revert "Test again" This reverts commit af21767e1cb748412d595d6374aa1db82fc2924b. --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 864a9d1931332..27909ca329df8 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -3,7 +3,8 @@ bugprone-unsafe-functions ========================= -Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. +Checks for functions that have safer, more secure replacements available, or +are considered deprecated due to design flaws. The check heavily relies on the functions from the **Annex K.** "Bounds-checking interfaces" of C11. >From 28e3af7932f6f51cf1d1e0dc3a9c30541026101c Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:01:29 +0800 Subject: [PATCH 13/27] Test clang-tidy --- clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp index 3887afe703389..40ea62023bcdf 100644 --- a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp +++ b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp @@ -99,7 +99,7 @@ void SuperSelfCheck::check(const MatchFinder::MatchResult &Result) { return; Diag << FixItHint::CreateReplacement(Message->getSourceRange(), - StringRef("[super init]")); + StringRef("[super init]")) } } // namespace clang::tidy::objc >From 42f00d741bbb00963ae25d22e3202f5499cf24a5 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:08:37 +0800 Subject: [PATCH 14/27] Revert "Test clang-tidy" This reverts commit 28e3af7932f6f51cf1d1e0dc3a9c30541026101c. --- clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp index 40ea62023bcdf..3887afe703389 100644 --- a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp +++ b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp @@ -99,7 +99,7 @@ void SuperSelfCheck::check(const MatchFinder::MatchResult &Result) { return; Diag << FixItHint::CreateReplacement(Message->getSourceRange(), - StringRef("[super init]")) + StringRef("[super init]")); } } // namespace clang::tidy::objc >From eaf9c697a6856f0102630585e6da87005b382fe4 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:16:04 +0800 Subject: [PATCH 15/27] Reapply "Test clang-tidy" This reverts commit 42f00d741bbb00963ae25d22e3202f5499cf24a5. --- clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp index 3887afe703389..40ea62023bcdf 100644 --- a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp +++ b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp @@ -99,7 +99,7 @@ void SuperSelfCheck::check(const MatchFinder::MatchResult &Result) { return; Diag << FixItHint::CreateReplacement(Message->getSourceRange(), - StringRef("[super init]")); + StringRef("[super init]")) } } // namespace clang::tidy::objc >From e1393be4b90b7f704b09e802521a65f9bc03eb63 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:16:16 +0800 Subject: [PATCH 16/27] Reapply "Test again" This reverts commit d3bdea8d506c17a0fc3b37feed580f9209a18b48. --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 27909ca329df8..864a9d1931332 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -3,8 +3,7 @@ bugprone-unsafe-functions ========================= -Checks for functions that have safer, more secure replacements available, or -are considered deprecated due to design flaws. +Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. The check heavily relies on the functions from the **Annex K.** "Bounds-checking interfaces" of C11. >From 50f345d05ef575957569bdf49f5940778f3da057 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:22:37 +0800 Subject: [PATCH 17/27] Revert "Reapply "Test again"" This reverts commit e1393be4b90b7f704b09e802521a65f9bc03eb63. --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 864a9d1931332..27909ca329df8 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -3,7 +3,8 @@ bugprone-unsafe-functions ========================= -Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. +Checks for functions that have safer, more secure replacements available, or +are considered deprecated due to design flaws. The check heavily relies on the functions from the **Annex K.** "Bounds-checking interfaces" of C11. >From c11c54f255847f2f07719884ebe25f2b69980ad9 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:22:42 +0800 Subject: [PATCH 18/27] Revert "Reapply "Test clang-tidy"" This reverts commit eaf9c697a6856f0102630585e6da87005b382fe4. --- clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp index 40ea62023bcdf..3887afe703389 100644 --- a/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp +++ b/clang-tools-extra/clang-tidy/objc/SuperSelfCheck.cpp @@ -99,7 +99,7 @@ void SuperSelfCheck::check(const MatchFinder::MatchResult &Result) { return; Diag << FixItHint::CreateReplacement(Message->getSourceRange(), - StringRef("[super init]")) + StringRef("[super init]")); } } // namespace clang::tidy::objc >From 180119612f5d5392a6c0a702a4818cad548aed77 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Sun, 14 Dec 2025 15:29:25 +0800 Subject: [PATCH 19/27] Revert document change --- .../checks/bugprone/unsafe-functions.rst | 29 +++++++++---------- 1 file changed, 14 insertions(+), 15 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 27909ca329df8..cb7ea415c54b2 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -96,22 +96,21 @@ to be checked. The format is the following, without newlines: The functions are matched using POSIX extended regular expressions. *(Note: The regular expressions do not support negative* ``(?!)`` *matches.)* -The ``reason`` is optional and is used to provide additional information about -the reasoning behind the replacement. The default reason is -``is marked as unsafe``. +The ``reason`` is optional and is used to provide additional information about the +reasoning behind the replacement. The default reason is ``is marked as unsafe``. If ``replacement`` is empty, the default text ``it should not be used`` will be shown instead of the suggestion for a replacement. -If the ``reason`` starts with the character ``>``, the reason becomes fully -custom. The default suffix is disabled even if a ``replacement`` is present, -and only the reason message is shown after the matched function, to allow -better control over the suggestions. (The starting ``>`` and whitespace -directly after it are trimmed from the message.) +If the ``reason`` starts with the character ``>``, the reason becomes fully custom. +The default suffix is disabled even if a ``replacement`` is present, and only the +reason message is shown after the matched function, to allow better control over +the suggestions. (The starting ``>`` and whitespace directly after it are +trimmed from the message.) -As an example, the following configuration matches only the function -``original`` in the default namespace. A similar diagnostic can also be -printed using a fully custom reason. +As an example, the following configuration matches only the function ``original`` +in the default namespace. A similar diagnostic can also be printed using a fully +custom reason. .. code:: c @@ -124,10 +123,10 @@ printed using a fully custom reason. ::std::original(); // no-warning original_function(); // no-warning -If the regular expression contains the character ``:``, it is matched against -the qualified name (i.e. ``std::original``), otherwise the regex is matched -against the unqualified name (``original``). If the regular expression starts -with ``::`` (or ``^::``), it is matched against the fully qualified name +If the regular expression contains the character ``:``, it is matched against the +qualified name (i.e. ``std::original``), otherwise the regex is matched against +the unqualified name (``original``). If the regular expression starts with ``::`` +(or ``^::``), it is matched against the fully qualified name (``::std::original``). One of the use cases for fully custom messages is suggesting compiler options >From 9538b3d497bbfcbe66ed4e8969f8885dfee4e03c Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Mon, 15 Dec 2025 09:18:44 +0800 Subject: [PATCH 20/27] Fix 80 char (but darker may dislike it?) --- llvm/utils/git/code-lint-helper.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index b2ab101e6d1b9..1755e9a951b13 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -308,7 +308,9 @@ def _should_lint_file(self, filepath: str) -> bool: and os.path.exists(filepath) ) - def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: + def run_linter_tool( + self, files_to_lint: Iterable[str], args: LintArgs + ) -> str: if not files_to_lint: return "" >From 1b754f113362fb1983f737a70dbc078a3763380c Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Mon, 15 Dec 2025 09:22:54 +0800 Subject: [PATCH 21/27] Revert "Fix 80 char (but darker may dislike it?)" This reverts commit 9538b3d497bbfcbe66ed4e8969f8885dfee4e03c. --- llvm/utils/git/code-lint-helper.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index 1755e9a951b13..b2ab101e6d1b9 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -308,9 +308,7 @@ def _should_lint_file(self, filepath: str) -> bool: and os.path.exists(filepath) ) - def run_linter_tool( - self, files_to_lint: Iterable[str], args: LintArgs - ) -> str: + def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: if not files_to_lint: return "" >From 2e56bef3c793b120b24de29fdeb174a6519294a6 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Mon, 15 Dec 2025 15:10:13 +0800 Subject: [PATCH 22/27] Test workaround --- .../github-action-ci-tooling/Dockerfile | 4 ---- .github/workflows/pr-code-lint.yml | 2 +- llvm/utils/git/requirements_linting.txt | 24 ++++++++++++++++++- llvm/utils/git/requirements_linting.txt.in | 1 + 4 files changed, 25 insertions(+), 6 deletions(-) diff --git a/.github/workflows/containers/github-action-ci-tooling/Dockerfile b/.github/workflows/containers/github-action-ci-tooling/Dockerfile index 6ac090e9a3385..cbd0b69b76192 100644 --- a/.github/workflows/containers/github-action-ci-tooling/Dockerfile +++ b/.github/workflows/containers/github-action-ci-tooling/Dockerfile @@ -94,10 +94,6 @@ COPY --from=llvm-downloader /llvm-extract/LLVM-${LLVM_VERSION}-Linux-X64/bin/cla COPY clang-tools-extra/clang-tidy/tool/clang-tidy-diff.py ${LLVM_SYSROOT}/bin/clang-tidy-diff.py # Install dependencies for 'pr-code-lint.yml' job -RUN apt-get update && \ - DEBIAN_FRONTEND=noninteractive apt-get install -y python3-doc8 && \ - apt-get clean && \ - rm -rf /var/lib/apt/lists/* COPY llvm/utils/git/requirements_linting.txt requirements_linting.txt RUN pip install -r requirements_linting.txt --break-system-packages && \ rm requirements_linting.txt diff --git a/.github/workflows/pr-code-lint.yml b/.github/workflows/pr-code-lint.yml index d04a0f5c46b3a..64fecd26af004 100644 --- a/.github/workflows/pr-code-lint.yml +++ b/.github/workflows/pr-code-lint.yml @@ -20,7 +20,7 @@ jobs: run: shell: bash container: - image: 'ghcr.io/llvm/ci-ubuntu-24.04-lint-doc8' + image: 'ghcr.io/llvm/ci-ubuntu-24.04-lint' timeout-minutes: 60 concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/llvm/utils/git/requirements_linting.txt b/llvm/utils/git/requirements_linting.txt index b985b80aa869e..fc95278cea362 100644 --- a/llvm/utils/git/requirements_linting.txt +++ b/llvm/utils/git/requirements_linting.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.12 +# This file is autogenerated by pip-compile with Python 3.13 # by the following command: # # pip-compile --generate-hashes --output-file=requirements_linting.txt requirements_linting.txt.in @@ -203,6 +203,16 @@ deprecated==1.2.18 \ --hash=sha256:422b6f6d859da6f2ef57857761bfb392480502a64c3028ca9bbe86085d72115d \ --hash=sha256:bd5011788200372a32418f888e326a09ff80d0214bd961147cfed01b5c018eec # via pygithub +doc8==2.0.0 \ + --hash=sha256:1267ad32758971fbcf991442417a3935c7bc9e52550e73622e0e56ba55ea1d40 \ + --hash=sha256:9862710027f793c25f9b1899150660e4bf1d4c9a6738742e71f32011e2e3f590 + # via -r requirements_linting.txt.in +docutils==0.21.2 \ + --hash=sha256:3a6b18732edf182daa3cd12775bbb338cf5691468f91eeeb109deff6ebfa986f \ + --hash=sha256:dafca5b9e384f0e419294eb4d2ff9fa826435bf15f15b7bd45723e8ad76811b2 + # via + # doc8 + # restructuredtext-lint idna==3.10 \ --hash=sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9 \ --hash=sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3 @@ -215,6 +225,10 @@ pygithub==1.59.1 \ --hash=sha256:3d87a822e6c868142f0c2c4bf16cce4696b5a7a4d142a7bd160e1bdf75bc54a9 \ --hash=sha256:c44e3a121c15bf9d3a5cc98d94c9a047a5132a9b01d22264627f58ade9ddc217 # via -r requirements_linting.txt.in +pygments==2.19.2 \ + --hash=sha256:636cb2477cec7f8952536970bc533bc43743542f70392ae026374600add5b887 \ + --hash=sha256:86540386c03d588bb81d44bc3928634ff26449851e99741617ecb9037ee5ec0b + # via doc8 pyjwt[crypto]==2.10.1 \ --hash=sha256:3cc5772eb20009233caf06e9d8a0577824723b44e6648ee0a2aedb6cf9381953 \ --hash=sha256:dcdd193e30abefd5debf142f9adfcdd2b58004e644f25406ffaebd50bd98dacb @@ -235,6 +249,14 @@ requests==2.32.5 \ --hash=sha256:2462f94637a34fd532264295e186976db0f5d453d1cdd31473c85a6a161affb6 \ --hash=sha256:dbba0bac56e100853db0ea71b82b4dfd5fe2bf6d3754a8893c3af500cec7d7cf # via pygithub +restructuredtext-lint==2.0.2 \ + --hash=sha256:374c0d3e7e0867b2335146a145343ac619400623716b211b9a010c94426bbed7 \ + --hash=sha256:dd25209b9e0b726929d8306339faf723734a3137db382bcf27294fa18a6bc52b + # via doc8 +stevedore==5.6.0 \ + --hash=sha256:4a36dccefd7aeea0c70135526cecb7766c4c84c473b1af68db23d541b6dc1820 \ + --hash=sha256:f22d15c6ead40c5bbfa9ca54aa7e7b4a07d59b36ae03ed12ced1a54cf0b51945 + # via doc8 urllib3==2.5.0 \ --hash=sha256:3fc47733c7e419d4bc3f6b3dc2b4f890bb743906a30d56ba4a5bfa4bbff92760 \ --hash=sha256:e6b01673c0fa6a13e374b50871808eb3bf7046c4b125b216f6bf1cc604cff0dc diff --git a/llvm/utils/git/requirements_linting.txt.in b/llvm/utils/git/requirements_linting.txt.in index 33c997c022315..4abcef75ef6fa 100644 --- a/llvm/utils/git/requirements_linting.txt.in +++ b/llvm/utils/git/requirements_linting.txt.in @@ -1 +1,2 @@ PyGithub==1.59.1 +doc8==2.0.0 >From 3229a812feb30fe27c400facc5be5c0d4fb6cbe2 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Mon, 15 Dec 2025 15:16:58 +0800 Subject: [PATCH 23/27] Reapply "Reapply "Test again"" This reverts commit 50f345d05ef575957569bdf49f5940778f3da057. --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index cb7ea415c54b2..110abe0183397 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -3,8 +3,7 @@ bugprone-unsafe-functions ========================= -Checks for functions that have safer, more secure replacements available, or -are considered deprecated due to design flaws. +Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. The check heavily relies on the functions from the **Annex K.** "Bounds-checking interfaces" of C11. >From 57001169f803d3ffa22ae76708b4bc3d9b14bc8c Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Tue, 16 Dec 2025 10:46:07 +0800 Subject: [PATCH 24/27] Revert "Reapply "Reapply "Test again""" This reverts commit 3229a812feb30fe27c400facc5be5c0d4fb6cbe2. --- .../docs/clang-tidy/checks/bugprone/unsafe-functions.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst index 110abe0183397..cb7ea415c54b2 100644 --- a/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst +++ b/clang-tools-extra/docs/clang-tidy/checks/bugprone/unsafe-functions.rst @@ -3,7 +3,8 @@ bugprone-unsafe-functions ========================= -Checks for functions that have safer, more secure replacements available, or are considered deprecated due to design flaws. +Checks for functions that have safer, more secure replacements available, or +are considered deprecated due to design flaws. The check heavily relies on the functions from the **Annex K.** "Bounds-checking interfaces" of C11. >From 66cb5a1dc9e84bc86ce3f5ae7370ffad0f17d1e9 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Tue, 16 Dec 2025 10:53:58 +0800 Subject: [PATCH 25/27] Add documentations --- clang-tools-extra/docs/clang-tidy/Contributing.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/clang-tools-extra/docs/clang-tidy/Contributing.rst b/clang-tools-extra/docs/clang-tidy/Contributing.rst index 4ede4ea36c13d..4902769d08820 100644 --- a/clang-tools-extra/docs/clang-tidy/Contributing.rst +++ b/clang-tools-extra/docs/clang-tidy/Contributing.rst @@ -451,6 +451,19 @@ your build tree. Make sure that your check is correctly shown in the release no list of checks. Make sure that the formatting and structure of your check's documentation look correct. +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 ---------------------- >From 09d93db8f2f922cee914c19f63f3c1c8b9d7671f Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Tue, 16 Dec 2025 12:50:40 +0800 Subject: [PATCH 26/27] Add more hints --- llvm/utils/git/code-lint-helper.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index b2ab101e6d1b9..7b4f1d81bbced 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -332,6 +332,11 @@ def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: parts: List[str] = [] if output := proc.stdout.strip(): parts.append(output) + if "D001" in output or "Line too long" in output: + parts.append( + "Note: documentation lines should be no more than 79 characters wide." + ) + if error_output := proc.stderr.strip(): parts.append(f"stderr:\n{error_output}") >From 07a637b1e7763af64782956f4020a5067d66d954 Mon Sep 17 00:00:00 2001 From: mtx <[email protected]> Date: Tue, 16 Dec 2025 13:08:00 +0800 Subject: [PATCH 27/27] Beautify Note display --- llvm/utils/git/code-lint-helper.py | 18 ++++++++++++++---- 1 file changed, 14 insertions(+), 4 deletions(-) diff --git a/llvm/utils/git/code-lint-helper.py b/llvm/utils/git/code-lint-helper.py index 7b4f1d81bbced..df6eb74b3c426 100644 --- a/llvm/utils/git/code-lint-helper.py +++ b/llvm/utils/git/code-lint-helper.py @@ -298,6 +298,20 @@ class Doc8LintHelper(LintHelper): def instructions(self, files_to_lint: Iterable[str], args: LintArgs) -> str: return f"doc8 -q {' '.join(files_to_lint)}" + def create_comment_text( + self, linter_output: str, files_to_lint: Sequence[str], args: LintArgs + ) -> str: + comment = super().create_comment_text(linter_output, files_to_lint, args) + if "D001" in linter_output or "Line too long" in linter_output: + parts = comment.rsplit("</details>", 1) + if len(parts) == 2: + return ( + parts[0] + + "\nNote: documentation lines should be no more than 79 characters wide.\n</details>" + + parts[1] + ) + return comment + def filter_changed_files(self, changed_files: Iterable[str]) -> Sequence[str]: return list(filter(self._should_lint_file, changed_files)) @@ -332,10 +346,6 @@ def run_linter_tool(self, files_to_lint: Iterable[str], args: LintArgs) -> str: parts: List[str] = [] if output := proc.stdout.strip(): parts.append(output) - if "D001" in output or "Line too long" in output: - parts.append( - "Note: documentation lines should be no more than 79 characters wide." - ) if error_output := proc.stderr.strip(): parts.append(f"stderr:\n{error_output}") _______________________________________________ cfe-commits mailing list [email protected] https://lists.llvm.org/cgi-bin/mailman/listinfo/cfe-commits
