[clang-tools-extra] [clang-tidy][NFC] Add a unittest for checking list.rst (PR #193134)

Zeyi Xu via cfe-commits cfe-commits at lists.llvm.org
Tue Apr 21 00:12:18 PDT 2026


https://github.com/zeyi2 updated https://github.com/llvm/llvm-project/pull/193134

>From 142655486fb5591f3fdcfa83168ec423c5855e8e Mon Sep 17 00:00:00 2001
From: mtx <mitchell.xu2 at gmail.com>
Date: Tue, 21 Apr 2026 11:14:17 +0800
Subject: [PATCH 1/5] [clang-tidy][NFC] Add a unittest for checking list.rst

---
 .../clang-tidy/tool/check_update_docs.py      | 87 +++++++++++++++++++
 .../infrastructure/update-checks-list.test    |  2 +
 2 files changed, 89 insertions(+)
 create mode 100644 clang-tools-extra/clang-tidy/tool/check_update_docs.py
 create mode 100644 clang-tools-extra/test/clang-tidy/infrastructure/update-checks-list.test

diff --git a/clang-tools-extra/clang-tidy/tool/check_update_docs.py b/clang-tools-extra/clang-tidy/tool/check_update_docs.py
new file mode 100644
index 0000000000000..bd57cfe55c9bd
--- /dev/null
+++ b/clang-tools-extra/clang-tidy/tool/check_update_docs.py
@@ -0,0 +1,87 @@
+#!/usr/bin/env python3
+#
+# ===-----------------------------------------------------------------------===#
+#
+# Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
+# See https://llvm.org/LICENSE.txt for license information.
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# ===-----------------------------------------------------------------------===#
+
+"""
+
+Clang-Tidy Check List Checker
+=============================
+
+This wrapper script runs `add_new_check.py --update-docs` on
+a temporary copy of clang-tools-extra/{clang-tidy,docs} and
+writes the generated docs/clang-tidy/checks/list.rst to the
+requested output path.
+"""
+
+import argparse
+import io
+import os
+import shutil
+import subprocess
+import sys
+import tempfile
+from typing import Sequence
+
+
+EXTRA_DIR = os.path.join(os.path.dirname(__file__), "../..")
+CLANG_TIDY_DIR = os.path.join(EXTRA_DIR, "clang-tidy")
+DOCS_DIR = os.path.join(EXTRA_DIR, "docs")
+LIST_DOC = os.path.join(DOCS_DIR, "clang-tidy", "checks", "list.rst")
+
+
+def read_text(path: str) -> str:
+    with io.open(path, "r", encoding="utf-8") as f:
+        return f.read()
+
+
+def write_text(path: str, content: str) -> None:
+    with io.open(path, "w", encoding="utf-8", newline="") as f:
+        f.write(content)
+
+
+def generate_updated_list() -> str:
+    with tempfile.TemporaryDirectory() as td:
+        temp_root = os.path.join(td, "clang-tools-extra")
+        temp_clang_tidy_dir = os.path.join(temp_root, "clang-tidy")
+        temp_docs_dir = os.path.join(temp_root, "docs")
+
+        shutil.copytree(CLANG_TIDY_DIR, temp_clang_tidy_dir)
+        shutil.copytree(DOCS_DIR, temp_docs_dir)
+
+        subprocess.run(
+            [sys.executable, os.path.join(temp_clang_tidy_dir, "add_new_check.py"), "--update-docs"],
+            cwd=temp_clang_tidy_dir,
+            check=True,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.STDOUT,
+            text=True,
+        )
+
+        return read_text(os.path.join(temp_docs_dir, "clang-tidy", "checks", "list.rst"))
+
+
+def main(argv: Sequence[str]) -> int:
+    ap = argparse.ArgumentParser()
+    ap.add_argument("-o", "--output", dest="out", required=True)
+    args = ap.parse_args(argv)
+
+    generated = generate_updated_list()
+    write_text(args.out, generated)
+
+    if read_text(LIST_DOC) != generated:
+        sys.stderr.write(
+            "\n'clang-tools-extra/docs/clang-tidy/checks/list.rst' is out of date.\n"
+            "Fix it by running 'clang-tools-extra/clang-tidy/add_new_check.py --update-docs'.\n\n"
+        )
+
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main(sys.argv[1:]))
diff --git a/clang-tools-extra/test/clang-tidy/infrastructure/update-checks-list.test b/clang-tools-extra/test/clang-tidy/infrastructure/update-checks-list.test
new file mode 100644
index 0000000000000..cb3fc3d494e81
--- /dev/null
+++ b/clang-tools-extra/test/clang-tidy/infrastructure/update-checks-list.test
@@ -0,0 +1,2 @@
+// RUN: %python %S/../../../clang-tidy/tool/check_update_docs.py -o %t.clang-tidy-checks-list.rst
+// RUN: diff --strip-trailing-cr %S/../../../docs/clang-tidy/checks/list.rst %t.clang-tidy-checks-list.rst

>From c0a63efdac4a183356ebcb66e762f0712836ab6e Mon Sep 17 00:00:00 2001
From: mtx <mitchell.xu2 at gmail.com>
Date: Tue, 21 Apr 2026 11:16:32 +0800
Subject: [PATCH 2/5] fixup

---
 clang-tools-extra/clang-tidy/tool/check_update_docs.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/clang-tools-extra/clang-tidy/tool/check_update_docs.py b/clang-tools-extra/clang-tidy/tool/check_update_docs.py
index bd57cfe55c9bd..0a85749caa114 100644
--- a/clang-tools-extra/clang-tidy/tool/check_update_docs.py
+++ b/clang-tools-extra/clang-tidy/tool/check_update_docs.py
@@ -55,7 +55,11 @@ def generate_updated_list() -> str:
         shutil.copytree(DOCS_DIR, temp_docs_dir)
 
         subprocess.run(
-            [sys.executable, os.path.join(temp_clang_tidy_dir, "add_new_check.py"), "--update-docs"],
+            [
+                sys.executable,
+                os.path.join(temp_clang_tidy_dir, "add_new_check.py"),
+                "--update-docs",
+            ],
             cwd=temp_clang_tidy_dir,
             check=True,
             stdout=subprocess.PIPE,
@@ -63,7 +67,9 @@ def generate_updated_list() -> str:
             text=True,
         )
 
-        return read_text(os.path.join(temp_docs_dir, "clang-tidy", "checks", "list.rst"))
+        return read_text(
+            os.path.join(temp_docs_dir, "clang-tidy", "checks", "list.rst")
+        )
 
 
 def main(argv: Sequence[str]) -> int:

>From 846c9e5866ec202c7c69c39ae61089bdf45ff91c Mon Sep 17 00:00:00 2001
From: mtx <mitchell.xu2 at gmail.com>
Date: Tue, 21 Apr 2026 14:50:29 +0800
Subject: [PATCH 3/5] better?

---
 clang-tools-extra/clang-tidy/tool/check_update_docs.py | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/clang-tools-extra/clang-tidy/tool/check_update_docs.py b/clang-tools-extra/clang-tidy/tool/check_update_docs.py
index 0a85749caa114..6f026739f8c54 100644
--- a/clang-tools-extra/clang-tidy/tool/check_update_docs.py
+++ b/clang-tools-extra/clang-tidy/tool/check_update_docs.py
@@ -26,13 +26,13 @@
 import subprocess
 import sys
 import tempfile
-from typing import Sequence
+from typing import Final, Sequence
 
 
-EXTRA_DIR = os.path.join(os.path.dirname(__file__), "../..")
-CLANG_TIDY_DIR = os.path.join(EXTRA_DIR, "clang-tidy")
-DOCS_DIR = os.path.join(EXTRA_DIR, "docs")
-LIST_DOC = os.path.join(DOCS_DIR, "clang-tidy", "checks", "list.rst")
+EXTRA_DIR: Final = os.path.join(os.path.dirname(__file__), "../..")
+CLANG_TIDY_DIR: Final = os.path.join(EXTRA_DIR, "clang-tidy")
+DOCS_DIR: Final = os.path.join(EXTRA_DIR, "docs")
+LIST_DOC: Final = os.path.join(DOCS_DIR, "clang-tidy", "checks", "list.rst")
 
 
 def read_text(path: str) -> str:

>From 46e44e231529d3a5187a759734c0ebd3ddb0a114 Mon Sep 17 00:00:00 2001
From: mtx <mitchell.xu2 at gmail.com>
Date: Tue, 21 Apr 2026 14:53:01 +0800
Subject: [PATCH 4/5] Test that this fails as expected :)

---
 clang-tools-extra/docs/clang-tidy/checks/list.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index 053ce6f0779d9..8203313046fb0 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -76,21 +76,21 @@ Clang-Tidy Checks
    :doc:`android-cloexec-pipe2 <android/cloexec-pipe2>`, "Yes"
    :doc:`android-cloexec-socket <android/cloexec-socket>`, "Yes"
    :doc:`android-comparison-in-temp-failure-retry <android/comparison-in-temp-failure-retry>`,
+   :doc:`bugprone-argument-comment <bugprone/argument-comment>`, "Yes"
    :doc:`boost-use-ranges <boost/use-ranges>`, "Yes"
+   :doc:`bugprone-assignment-in-if-condition <bugprone/assignment-in-if-condition>`,
    :doc:`boost-use-to-string <boost/use-to-string>`, "Yes"
-   :doc:`bugprone-argument-comment <bugprone/argument-comment>`, "Yes"
    :doc:`bugprone-assert-side-effect <bugprone/assert-side-effect>`,
-   :doc:`bugprone-assignment-in-if-condition <bugprone/assignment-in-if-condition>`,
    :doc:`bugprone-assignment-in-selection-statement <bugprone/assignment-in-selection-statement>`,
-   :doc:`bugprone-bad-signal-to-kill-thread <bugprone/bad-signal-to-kill-thread>`,
    :doc:`bugprone-bitwise-pointer-cast <bugprone/bitwise-pointer-cast>`,
    :doc:`bugprone-bool-pointer-implicit-conversion <bugprone/bool-pointer-implicit-conversion>`, "Yes"
    :doc:`bugprone-branch-clone <bugprone/branch-clone>`,
+   :doc:`bugprone-bad-signal-to-kill-thread <bugprone/bad-signal-to-kill-thread>`,
    :doc:`bugprone-capturing-this-in-member-variable <bugprone/capturing-this-in-member-variable>`,
-   :doc:`bugprone-casting-through-void <bugprone/casting-through-void>`,
    :doc:`bugprone-chained-comparison <bugprone/chained-comparison>`,
-   :doc:`bugprone-command-processor <bugprone/command-processor>`,
+   :doc:`bugprone-casting-through-void <bugprone/casting-through-void>`,
    :doc:`bugprone-compare-pointer-to-member-virtual-function <bugprone/compare-pointer-to-member-virtual-function>`,
+   :doc:`bugprone-command-processor <bugprone/command-processor>`,
    :doc:`bugprone-copy-constructor-init <bugprone/copy-constructor-init>`, "Yes"
    :doc:`bugprone-copy-constructor-mutates-argument <bugprone/copy-constructor-mutates-argument>`,
    :doc:`bugprone-crtp-constructor-accessibility <bugprone/crtp-constructor-accessibility>`, "Yes"
@@ -99,14 +99,14 @@ Clang-Tidy Checks
    :doc:`bugprone-derived-method-shadowing-base-method <bugprone/derived-method-shadowing-base-method>`,
    :doc:`bugprone-dynamic-static-initializers <bugprone/dynamic-static-initializers>`,
    :doc:`bugprone-easily-swappable-parameters <bugprone/easily-swappable-parameters>`,
-   :doc:`bugprone-empty-catch <bugprone/empty-catch>`,
    :doc:`bugprone-exception-copy-constructor-throws <bugprone/exception-copy-constructor-throws>`,
    :doc:`bugprone-exception-escape <bugprone/exception-escape>`,
    :doc:`bugprone-float-loop-counter <bugprone/float-loop-counter>`,
+   :doc:`bugprone-empty-catch <bugprone/empty-catch>`,
    :doc:`bugprone-fold-init-type <bugprone/fold-init-type>`,
    :doc:`bugprone-forward-declaration-namespace <bugprone/forward-declaration-namespace>`,
    :doc:`bugprone-forwarding-reference-overload <bugprone/forwarding-reference-overload>`,
-   :doc:`bugprone-implicit-widening-of-multiplication-result <bugprone/implicit-widening-of-multiplication-result>`, "Yes"
+   :doc:`bugprone-implicit-widening-of-multiplication-result <bugprone/implicit-widening-of-multiplication-result>`
    :doc:`bugprone-inaccurate-erase <bugprone/inaccurate-erase>`, "Yes"
    :doc:`bugprone-inc-dec-in-conditions <bugprone/inc-dec-in-conditions>`,
    :doc:`bugprone-incorrect-enable-if <bugprone/incorrect-enable-if>`, "Yes"

>From e3a6202ad47823b170d5320ac6998b2263e10a40 Mon Sep 17 00:00:00 2001
From: mtx <mitchell.xu2 at gmail.com>
Date: Tue, 21 Apr 2026 15:11:54 +0800
Subject: [PATCH 5/5] revert it

---
 clang-tools-extra/docs/clang-tidy/checks/list.rst | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/clang-tools-extra/docs/clang-tidy/checks/list.rst b/clang-tools-extra/docs/clang-tidy/checks/list.rst
index 8203313046fb0..053ce6f0779d9 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/list.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/list.rst
@@ -76,21 +76,21 @@ Clang-Tidy Checks
    :doc:`android-cloexec-pipe2 <android/cloexec-pipe2>`, "Yes"
    :doc:`android-cloexec-socket <android/cloexec-socket>`, "Yes"
    :doc:`android-comparison-in-temp-failure-retry <android/comparison-in-temp-failure-retry>`,
-   :doc:`bugprone-argument-comment <bugprone/argument-comment>`, "Yes"
    :doc:`boost-use-ranges <boost/use-ranges>`, "Yes"
-   :doc:`bugprone-assignment-in-if-condition <bugprone/assignment-in-if-condition>`,
    :doc:`boost-use-to-string <boost/use-to-string>`, "Yes"
+   :doc:`bugprone-argument-comment <bugprone/argument-comment>`, "Yes"
    :doc:`bugprone-assert-side-effect <bugprone/assert-side-effect>`,
+   :doc:`bugprone-assignment-in-if-condition <bugprone/assignment-in-if-condition>`,
    :doc:`bugprone-assignment-in-selection-statement <bugprone/assignment-in-selection-statement>`,
+   :doc:`bugprone-bad-signal-to-kill-thread <bugprone/bad-signal-to-kill-thread>`,
    :doc:`bugprone-bitwise-pointer-cast <bugprone/bitwise-pointer-cast>`,
    :doc:`bugprone-bool-pointer-implicit-conversion <bugprone/bool-pointer-implicit-conversion>`, "Yes"
    :doc:`bugprone-branch-clone <bugprone/branch-clone>`,
-   :doc:`bugprone-bad-signal-to-kill-thread <bugprone/bad-signal-to-kill-thread>`,
    :doc:`bugprone-capturing-this-in-member-variable <bugprone/capturing-this-in-member-variable>`,
-   :doc:`bugprone-chained-comparison <bugprone/chained-comparison>`,
    :doc:`bugprone-casting-through-void <bugprone/casting-through-void>`,
-   :doc:`bugprone-compare-pointer-to-member-virtual-function <bugprone/compare-pointer-to-member-virtual-function>`,
+   :doc:`bugprone-chained-comparison <bugprone/chained-comparison>`,
    :doc:`bugprone-command-processor <bugprone/command-processor>`,
+   :doc:`bugprone-compare-pointer-to-member-virtual-function <bugprone/compare-pointer-to-member-virtual-function>`,
    :doc:`bugprone-copy-constructor-init <bugprone/copy-constructor-init>`, "Yes"
    :doc:`bugprone-copy-constructor-mutates-argument <bugprone/copy-constructor-mutates-argument>`,
    :doc:`bugprone-crtp-constructor-accessibility <bugprone/crtp-constructor-accessibility>`, "Yes"
@@ -99,14 +99,14 @@ Clang-Tidy Checks
    :doc:`bugprone-derived-method-shadowing-base-method <bugprone/derived-method-shadowing-base-method>`,
    :doc:`bugprone-dynamic-static-initializers <bugprone/dynamic-static-initializers>`,
    :doc:`bugprone-easily-swappable-parameters <bugprone/easily-swappable-parameters>`,
+   :doc:`bugprone-empty-catch <bugprone/empty-catch>`,
    :doc:`bugprone-exception-copy-constructor-throws <bugprone/exception-copy-constructor-throws>`,
    :doc:`bugprone-exception-escape <bugprone/exception-escape>`,
    :doc:`bugprone-float-loop-counter <bugprone/float-loop-counter>`,
-   :doc:`bugprone-empty-catch <bugprone/empty-catch>`,
    :doc:`bugprone-fold-init-type <bugprone/fold-init-type>`,
    :doc:`bugprone-forward-declaration-namespace <bugprone/forward-declaration-namespace>`,
    :doc:`bugprone-forwarding-reference-overload <bugprone/forwarding-reference-overload>`,
-   :doc:`bugprone-implicit-widening-of-multiplication-result <bugprone/implicit-widening-of-multiplication-result>`
+   :doc:`bugprone-implicit-widening-of-multiplication-result <bugprone/implicit-widening-of-multiplication-result>`, "Yes"
    :doc:`bugprone-inaccurate-erase <bugprone/inaccurate-erase>`, "Yes"
    :doc:`bugprone-inc-dec-in-conditions <bugprone/inc-dec-in-conditions>`,
    :doc:`bugprone-incorrect-enable-if <bugprone/incorrect-enable-if>`, "Yes"



More information about the cfe-commits mailing list