Skip to content

Commit 9c91d4a

Browse files
authored
[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.
1 parent b6014b6 commit 9c91d4a

File tree

2 files changed

+18
-0
lines changed

2 files changed

+18
-0
lines changed

clang-tools-extra/docs/ReleaseNotes.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,21 @@ infrastructure are described first, followed by tool-specific sections.
4646
Major New Features
4747
------------------
4848

49+
Potentially Breaking Changes
50+
----------------------------
51+
52+
- Removed :program:`clang-tidy`'s global options `IgnoreMacros` and
53+
`StrictMode`, which were documented as deprecated since
54+
:program:`clang-tidy-20`. Users should use the check-specific options of the
55+
same name instead.
56+
57+
- Renamed :program:`clang-tidy`'s option name of check
58+
:doc:`bugprone-easily-swappable-parameters
59+
<clang-tidy/checks/bugprone/easily-swappable-parameters>` from
60+
``NamePrefixSuffixSilenceDissimilarityTreshold`` to
61+
``NamePrefixSuffixSilenceDissimilarityThreshold``,
62+
correcting a spelling mistake.
63+
4964
Improvements to clangd
5065
----------------------
5166

clang-tools-extra/docs/ReleaseNotesTemplate.txt

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,9 @@ infrastructure are described first, followed by tool-specific sections.
4646
Major New Features
4747
------------------
4848

49+
Potentially Breaking Changes
50+
----------------------------
51+
4952
Improvements to clangd
5053
----------------------
5154

0 commit comments

Comments
 (0)