[clang-tools-extra] [clang-tools-extra][docs] Cover all tools in the release notes (PR #233126)

via cfe-commits cfe-commits at lists.llvm.org
Sat Oct 17 12:09:28 PDT 2026


llvmorg-github-actions[bot] wrote:


<!--LLVM PR SUMMARY COMMENT-->

@llvm/pr-subscribers-clang-tools-extra

Author: Demo_mod (Glitch-On)

<details>
<summary>Changes</summary>

The Extra Clang Tools release notes have carried content for clang-tidy and, lately, clangd, while the other tools shipped release after release with empty sections even when they changed. Part of that is the template: it still has an "include-fixer" section left over from the 2019 rename to clang-include-fixer, next to the renamed one; it has a section for the clang-tidy Visual Studio plugin, which was removed in 2019 (559ae14c9b6c); and it has no section at all for clang-include-cleaner, clang-apply-replacements, clang-change-namespace, clang-move or clang-reorder-fields.

This gives every tool in clang-tools-extra its own section, drops the two dead ones, and keeps the sections after clangd in alphabetical order. The same edits are applied to `ReleaseNotes.md` and `ReleaseNotesTemplate.txt`, as the header comment in the notes asks, so the next release starts from the corrected layout.

It then fills in what this release changed outside clang-tidy and clangd but never noted: Objective-C support in the include-cleaner analysis (#<!-- -->211119, #<!-- -->212617, #<!-- -->212633, #<!-- -->212564, #<!-- -->216158, #<!-- -->216201), the main header insertion fix (#<!-- -->212852), and the clang-doc crash on invalid UTF-8 in comments (#<!-- -->210886). I went through every commit to the non-clang-tidy tools since the 23.x branch point; the remaining ones are clang-wide refactors with no user-visible effect. I did not audit clangd's commits, since clangd already has notes and its maintainers write those in bulk.

Checked by building the clang-tools-extra docs with Sphinx: no warnings on the release notes page, and the `{doc}` link to the `misc-include-cleaner` check resolves.

One judgment call: the four sections for tools with no changes this cycle will show up empty in the shipped notes, as five sections already did in 23.x. I kept them so the template works as a checklist for every tool, but I am happy to add only clang-include-cleaner if that is preferred.

Fixes #<!-- -->64324


---
Full diff: https://github.com/llvm/llvm-project/pull/233126.diff


2 Files Affected:

- (modified) clang-tools-extra/docs/ReleaseNotes.md (+30-6) 
- (modified) clang-tools-extra/docs/ReleaseNotesTemplate.txt (+12-6) 


``````````diff
diff --git a/clang-tools-extra/docs/ReleaseNotes.md b/clang-tools-extra/docs/ReleaseNotes.md
index 69f3ecee49926b..4509d05af82adf 100644
--- a/clang-tools-extra/docs/ReleaseNotes.md
+++ b/clang-tools-extra/docs/ReleaseNotes.md
@@ -124,10 +124,40 @@ infrastructure are described first, followed by tool-specific sections.
 - Added support for loading dynamic plugins via the `-load` command-line
   option.
 
+### Improvements to clang-apply-replacements
+
+### Improvements to clang-change-namespace
+
 ### Improvements to clang-doc
 
+- Fixed a crash, in builds with assertions enabled, when a documentation
+  comment contains invalid UTF-8. The text is now sanitized before it is
+  emitted.
+  ([#210675](https://github.com/llvm/llvm-project/issues/210675))
+
+### Improvements to clang-include-cleaner
+
+- Added Objective-C support to the include analysis. References made through
+  interfaces, protocols, categories, compatible aliases, instance variables,
+  properties, message sends, `@selector` expressions, literals and boxed
+  expressions, and toll-free bridged casts are now attributed to the headers
+  that declare them, and forward declarations of interfaces and protocols no
+  longer satisfy a use that needs the definition. This also applies to clangd
+  and to the clang-tidy {doc}`misc-include-cleaner
+  <clang-tidy/checks/misc/include-cleaner>` check, which share the analysis.
+
+- Fixed the main header of a source file being inserted at the wrong position
+  when several missing includes are added at once.
+  ([#212852](https://github.com/llvm/llvm-project/pull/212852))
+
+### Improvements to clang-include-fixer
+
+### Improvements to clang-move
+
 ### Improvements to clang-query
 
+### Improvements to clang-reorder-fields
+
 ### Improvements to clang-tidy
 
 - Improved {program}`check_clang_tidy.py` by adding support of
@@ -431,12 +461,6 @@ infrastructure are described first, followed by tool-specific sections.
   inserting a missing `#include`, which stopped {program}`clang-format` and
   the `llvm-include-order` check from being able to sort it correctly afterwards.
 
-### Improvements to include-fixer
-
-### Improvements to clang-include-fixer
-
 ### Improvements to modularize
 
 ### Improvements to pp-trace
-
-### Clang-tidy Visual Studio plugin
diff --git a/clang-tools-extra/docs/ReleaseNotesTemplate.txt b/clang-tools-extra/docs/ReleaseNotesTemplate.txt
index 8874e1d393c6aa..9cf55bf008bae5 100644
--- a/clang-tools-extra/docs/ReleaseNotesTemplate.txt
+++ b/clang-tools-extra/docs/ReleaseNotesTemplate.txt
@@ -80,10 +80,22 @@ infrastructure are described first, followed by tool-specific sections.
 
 #### Miscellaneous
 
+### Improvements to clang-apply-replacements
+
+### Improvements to clang-change-namespace
+
 ### Improvements to clang-doc
 
+### Improvements to clang-include-cleaner
+
+### Improvements to clang-include-fixer
+
+### Improvements to clang-move
+
 ### Improvements to clang-query
 
+### Improvements to clang-reorder-fields
+
 ### Improvements to clang-tidy
 
 #### New checks
@@ -96,12 +108,6 @@ infrastructure are described first, followed by tool-specific sections.
 
 #### Miscellaneous
 
-### Improvements to include-fixer
-
-### Improvements to clang-include-fixer
-
 ### Improvements to modularize
 
 ### Improvements to pp-trace
-
-### Clang-tidy Visual Studio plugin

``````````

</details>


https://github.com/llvm/llvm-project/pull/233126


More information about the cfe-commits mailing list