[clang-tools-extra] [clang-tidy] Remove `allow-long-titles` option in doc8 config (PR #173519)

via cfe-commits cfe-commits at lists.llvm.org
Wed Dec 24 18:38:57 PST 2025


https://github.com/zeyi2 created https://github.com/llvm/llvm-project/pull/173519

There is a bug in `doc8` where `allow-long-titles` option incorrectly skipping non-title lines. So we have to disable it before they solve the problem and make a new release.

>From 15b452b33bc78e92165e16620e03766fb06c6a1f Mon Sep 17 00:00:00 2001
From: mtx <mitchell.xu2 at gmail.com>
Date: Thu, 25 Dec 2025 10:35:36 +0800
Subject: [PATCH] [clang-tidy] Remove `allow-long-titles` option in doc8 config

---
 clang-tools-extra/clang-tidy/doc8.ini                          | 3 +--
 .../docs/clang-tidy/checks/misc/use-internal-linkage.rst       | 2 +-
 2 files changed, 2 insertions(+), 3 deletions(-)

diff --git a/clang-tools-extra/clang-tidy/doc8.ini b/clang-tools-extra/clang-tidy/doc8.ini
index 0e5b93511b967..f3670aaedec38 100644
--- a/clang-tools-extra/clang-tidy/doc8.ini
+++ b/clang-tools-extra/clang-tidy/doc8.ini
@@ -1,4 +1,3 @@
 [doc8]
 
-allow-long-titles = true
-ignore-path=clang-tools-extra/docs/clang-tidy/Integrations.rst
+ignore-path=clang-tools-extra/docs/clang-tidy/Integrations.rst,clang-tools-extra/docs/clang-tidy/checks/abseil/unchecked-statusor-access.rst
diff --git a/clang-tools-extra/docs/clang-tidy/checks/misc/use-internal-linkage.rst b/clang-tools-extra/docs/clang-tidy/checks/misc/use-internal-linkage.rst
index 8838837506a40..d87196ce664a8 100644
--- a/clang-tools-extra/docs/clang-tidy/checks/misc/use-internal-linkage.rst
+++ b/clang-tools-extra/docs/clang-tidy/checks/misc/use-internal-linkage.rst
@@ -17,7 +17,7 @@ Example:
   int v1; // can be marked as static
 
   void fn1() {} // can be marked as static
-  
+
   struct S1 {}; // can be moved into anonymous namespace
 
   namespace {



More information about the cfe-commits mailing list