[clang-tools-extra] 9c91d4a - [clang-tools-extra][docs] Add "Potentially Breaking Changes" section to ReleaseNotes (#158434)
via cfe-commits
cfe-commits at lists.llvm.org
Sun Sep 14 01:45:59 PDT 2025
Author: Baranov Victor
Date: 2025-09-14T11:45:55+03:00
New Revision: 9c91d4a31d758cbddc0fc6347470604c2040ab2f
URL: https://github.com/llvm/llvm-project/commit/9c91d4a31d758cbddc0fc6347470604c2040ab2f
DIFF: https://github.com/llvm/llvm-project/commit/9c91d4a31d758cbddc0fc6347470604c2040ab2f.diff
LOG: [clang-tools-extra][docs] Add "Potentially Breaking Changes" section to ReleaseNotes (#158434)
This implements:
https://github.com/llvm/llvm-project/blob/30e9cbacab5b474de89992851f126fff300c1ab7/llvm/docs/DeveloperPolicy.rst?plain=1#L282-L286
>From LLVM developer policy.
Added:
Modified:
clang-tools-extra/docs/ReleaseNotes.rst
clang-tools-extra/docs/ReleaseNotesTemplate.txt
Removed:
################################################################################
diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst
index 34091906cbff2..7cdff86beeec6 100644
--- a/clang-tools-extra/docs/ReleaseNotes.rst
+++ b/clang-tools-extra/docs/ReleaseNotes.rst
@@ -46,6 +46,21 @@ infrastructure are described first, followed by tool-specific sections.
Major New Features
------------------
+Potentially Breaking Changes
+----------------------------
+
+- Removed :program:`clang-tidy`'s global options `IgnoreMacros` and
+ `StrictMode`, which were documented as deprecated since
+ :program:`clang-tidy-20`. Users should use the check-specific options of the
+ same name instead.
+
+- Renamed :program:`clang-tidy`'s option name of check
+ :doc:`bugprone-easily-swappable-parameters
+ <clang-tidy/checks/bugprone/easily-swappable-parameters>` from
+ ``NamePrefixSuffixSilenceDissimilarityTreshold`` to
+ ``NamePrefixSuffixSilenceDissimilarityThreshold``,
+ correcting a spelling mistake.
+
Improvements to clangd
----------------------
diff --git a/clang-tools-extra/docs/ReleaseNotesTemplate.txt b/clang-tools-extra/docs/ReleaseNotesTemplate.txt
index b17799b3b557d..69c3bcf67b8db 100644
--- a/clang-tools-extra/docs/ReleaseNotesTemplate.txt
+++ b/clang-tools-extra/docs/ReleaseNotesTemplate.txt
@@ -46,6 +46,9 @@ infrastructure are described first, followed by tool-specific sections.
Major New Features
------------------
+Potentially Breaking Changes
+----------------------------
+
Improvements to clangd
----------------------
More information about the cfe-commits
mailing list