Skip to content

Commit 3b27d50

Browse files
zwuiszwuis
authored
[LLVM][utils] Add script which clears release notes (#153593)
The script copies `ReleaseNotesTemplate.txt` to corresponding `ReleaseNotes.rst`/`.md` to clear release notes. The suffix of `ReleaseNotesTemplate.txt` must be `.txt`. If it is `.rst`/`.md`, it will be treated as a documentation source file when building documentation.
1 parent 3db1742 commit 3b27d50

File tree

12 files changed

+703
-10
lines changed

12 files changed

+703
-10
lines changed

‎clang-tools-extra/docs/ReleaseNotes.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. If you want to modify sections/contents permanently, you should modify both
2+
ReleaseNotes.rst and ReleaseNotesTemplate.txt.
3+
14
====================================================
25
Extra Clang Tools |release| |ReleaseNotesTitle|
36
====================================================

‎clang-tools-extra/docs/ReleaseNotesTemplate.txt

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
.. If you want to modify sections/contents permanently, you should modify both
2+
ReleaseNotes.rst and ReleaseNotesTemplate.txt.
3+
4+
====================================================
5+
Extra Clang Tools |release| |ReleaseNotesTitle|
6+
====================================================
7+
8+
.. contents::
9+
:local:
10+
:depth: 3
11+
12+
Written by the `LLVM Team <https://llvm.org/>`_
13+
14+
.. only:: PreRelease
15+
16+
.. warning::
17+
These are in-progress notes for the upcoming Extra Clang Tools |version| release.
18+
Release notes for previous releases can be found on
19+
`the Download Page <https://releases.llvm.org/download.html>`_.
20+
21+
Introduction
22+
============
23+
24+
This document contains the release notes for the Extra Clang Tools, part of the
25+
Clang release |release|. Here we describe the status of the Extra Clang Tools in
26+
some detail, including major improvements from the previous release and new
27+
feature work. All LLVM releases may be downloaded from the `LLVM releases web
28+
site <https://llvm.org/releases/>`_.
29+
30+
For more information about Clang or LLVM, including information about
31+
the latest release, please see the `Clang Web Site <https://clang.llvm.org>`_ or
32+
the `LLVM Web Site <https://llvm.org>`_.
33+
34+
Note that if you are reading this file from a Git checkout or the
35+
main Clang web page, this document applies to the *next* release, not
36+
the current one. To see the release notes for a specific release, please
37+
see the `releases page <https://llvm.org/releases/>`_.
38+
39+
What's New in Extra Clang Tools |release|?
40+
==========================================
41+
42+
Some of the major new features and improvements to Extra Clang Tools are listed
43+
here. Generic improvements to Extra Clang Tools as a whole or to its underlying
44+
infrastructure are described first, followed by tool-specific sections.
45+
46+
Major New Features
47+
------------------
48+
49+
Improvements to clangd
50+
----------------------
51+
52+
Inlay hints
53+
^^^^^^^^^^^
54+
55+
Diagnostics
56+
^^^^^^^^^^^
57+
58+
Semantic Highlighting
59+
^^^^^^^^^^^^^^^^^^^^^
60+
61+
Compile flags
62+
^^^^^^^^^^^^^
63+
64+
Hover
65+
^^^^^
66+
67+
Code completion
68+
^^^^^^^^^^^^^^^
69+
70+
Code actions
71+
^^^^^^^^^^^^
72+
73+
Signature help
74+
^^^^^^^^^^^^^^
75+
76+
Cross-references
77+
^^^^^^^^^^^^^^^^
78+
79+
Objective-C
80+
^^^^^^^^^^^
81+
82+
Miscellaneous
83+
^^^^^^^^^^^^^
84+
85+
Improvements to clang-doc
86+
-------------------------
87+
88+
Improvements to clang-query
89+
---------------------------
90+
91+
Improvements to clang-tidy
92+
--------------------------
93+
94+
New checks
95+
^^^^^^^^^^
96+
97+
New check aliases
98+
^^^^^^^^^^^^^^^^^
99+
100+
Changes in existing checks
101+
^^^^^^^^^^^^^^^^^^^^^^^^^^
102+
103+
Removed checks
104+
^^^^^^^^^^^^^^
105+
106+
Miscellaneous
107+
^^^^^^^^^^^^^
108+
109+
Improvements to include-fixer
110+
-----------------------------
111+
112+
Improvements to clang-include-fixer
113+
-----------------------------------
114+
115+
Improvements to modularize
116+
--------------------------
117+
118+
Improvements to pp-trace
119+
------------------------
120+
121+
Clang-tidy Visual Studio plugin
122+
-------------------------------

‎clang/docs/ReleaseNotes.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
.. If you want to modify sections/contents permanently, you should modify both
2+
ReleaseNotes.rst and ReleaseNotesTemplate.txt.
3+
14
===========================================
25
Clang |release| |ReleaseNotesTitle|
36
===========================================

‎clang/docs/ReleaseNotesTemplate.txt

Lines changed: 246 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,246 @@
1+
.. If you want to modify sections/contents permanently, you should modify both
2+
ReleaseNotes.rst and ReleaseNotesTemplate.txt.
3+
4+
===========================================
5+
Clang |release| |ReleaseNotesTitle|
6+
===========================================
7+
8+
.. contents::
9+
:local:
10+
:depth: 2
11+
12+
Written by the `LLVM Team <https://llvm.org/>`_
13+
14+
.. only:: PreRelease
15+
16+
.. warning::
17+
These are in-progress notes for the upcoming Clang |version| release.
18+
Release notes for previous releases can be found on
19+
`the Releases Page <https://llvm.org/releases/>`_.
20+
21+
Introduction
22+
============
23+
24+
This document contains the release notes for the Clang C/C++/Objective-C
25+
frontend, part of the LLVM Compiler Infrastructure, release |release|. Here we
26+
describe the status of Clang in some detail, including major
27+
improvements from the previous release and new feature work. For the
28+
general LLVM release notes, see `the LLVM
29+
documentation <https://llvm.org/docs/ReleaseNotes.html>`_. For the libc++ release notes,
30+
see `this page <https://libcxx.llvm.org/ReleaseNotes.html>`_. All LLVM releases
31+
may be downloaded from the `LLVM releases web site <https://llvm.org/releases/>`_.
32+
33+
For more information about Clang or LLVM, including information about the
34+
latest release, please see the `Clang Web Site <https://clang.llvm.org>`_ or the
35+
`LLVM Web Site <https://llvm.org>`_.
36+
37+
Potentially Breaking Changes
38+
============================
39+
40+
C/C++ Language Potentially Breaking Changes
41+
-------------------------------------------
42+
43+
C++ Specific Potentially Breaking Changes
44+
-----------------------------------------
45+
46+
ABI Changes in This Version
47+
---------------------------
48+
49+
AST Dumping Potentially Breaking Changes
50+
----------------------------------------
51+
52+
Clang Frontend Potentially Breaking Changes
53+
-------------------------------------------
54+
55+
Clang Python Bindings Potentially Breaking Changes
56+
--------------------------------------------------
57+
58+
What's New in Clang |release|?
59+
==============================
60+
61+
C++ Language Changes
62+
--------------------
63+
64+
C++2c Feature Support
65+
^^^^^^^^^^^^^^^^^^^^^
66+
67+
C++23 Feature Support
68+
^^^^^^^^^^^^^^^^^^^^^
69+
70+
C++20 Feature Support
71+
^^^^^^^^^^^^^^^^^^^^^
72+
73+
C++17 Feature Support
74+
^^^^^^^^^^^^^^^^^^^^^
75+
76+
Resolutions to C++ Defect Reports
77+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
78+
79+
C Language Changes
80+
------------------
81+
82+
C2y Feature Support
83+
^^^^^^^^^^^^^^^^^^^
84+
85+
C23 Feature Support
86+
^^^^^^^^^^^^^^^^^^^
87+
88+
Non-comprehensive list of changes in this release
89+
-------------------------------------------------
90+
91+
New Compiler Flags
92+
------------------
93+
94+
Deprecated Compiler Flags
95+
-------------------------
96+
97+
Modified Compiler Flags
98+
-----------------------
99+
100+
Removed Compiler Flags
101+
----------------------
102+
103+
Attribute Changes in Clang
104+
--------------------------
105+
106+
Improvements to Clang's diagnostics
107+
-----------------------------------
108+
109+
Improvements to Clang's time-trace
110+
----------------------------------
111+
112+
Improvements to Coverage Mapping
113+
--------------------------------
114+
115+
Bug Fixes in This Version
116+
-------------------------
117+
118+
Bug Fixes to Compiler Builtins
119+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
120+
121+
Bug Fixes to Attribute Support
122+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
123+
124+
Bug Fixes to C++ Support
125+
^^^^^^^^^^^^^^^^^^^^^^^^
126+
127+
Bug Fixes to AST Handling
128+
^^^^^^^^^^^^^^^^^^^^^^^^^
129+
130+
Miscellaneous Bug Fixes
131+
^^^^^^^^^^^^^^^^^^^^^^^
132+
133+
Miscellaneous Clang Crashes Fixed
134+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
135+
136+
OpenACC Specific Changes
137+
------------------------
138+
139+
Target Specific Changes
140+
-----------------------
141+
142+
AMDGPU Support
143+
^^^^^^^^^^^^^^
144+
145+
NVPTX Support
146+
^^^^^^^^^^^^^^
147+
148+
X86 Support
149+
^^^^^^^^^^^
150+
151+
Arm and AArch64 Support
152+
^^^^^^^^^^^^^^^^^^^^^^^
153+
154+
Android Support
155+
^^^^^^^^^^^^^^^
156+
157+
Windows Support
158+
^^^^^^^^^^^^^^^
159+
160+
LoongArch Support
161+
^^^^^^^^^^^^^^^^^
162+
163+
RISC-V Support
164+
^^^^^^^^^^^^^^
165+
166+
CUDA/HIP Language Changes
167+
^^^^^^^^^^^^^^^^^^^^^^^^^
168+
169+
CUDA Support
170+
^^^^^^^^^^^^
171+
172+
AIX Support
173+
^^^^^^^^^^^
174+
175+
NetBSD Support
176+
^^^^^^^^^^^^^^
177+
178+
WebAssembly Support
179+
^^^^^^^^^^^^^^^^^^^
180+
181+
AVR Support
182+
^^^^^^^^^^^
183+
184+
DWARF Support in Clang
185+
----------------------
186+
187+
Floating Point Support in Clang
188+
-------------------------------
189+
190+
Fixed Point Support in Clang
191+
----------------------------
192+
193+
AST Matchers
194+
------------
195+
196+
clang-format
197+
------------
198+
199+
libclang
200+
--------
201+
202+
Code Completion
203+
---------------
204+
205+
Static Analyzer
206+
---------------
207+
208+
New features
209+
^^^^^^^^^^^^
210+
211+
Crash and bug fixes
212+
^^^^^^^^^^^^^^^^^^^
213+
214+
Improvements
215+
^^^^^^^^^^^^
216+
217+
Moved checkers
218+
^^^^^^^^^^^^^^
219+
220+
.. _release-notes-sanitizers:
221+
222+
Sanitizers
223+
----------
224+
225+
Python Binding Changes
226+
----------------------
227+
228+
OpenMP Support
229+
--------------
230+
231+
Improvements
232+
^^^^^^^^^^^^
233+
234+
Additional Information
235+
======================
236+
237+
A wide variety of additional information is available on the `Clang web
238+
page <https://clang.llvm.org/>`_. The web page contains versions of the
239+
API documentation which are up-to-date with the Git version of
240+
the source code. You can access versions of these documents specific to
241+
this release by going into the "``clang/docs/``" directory in the Clang
242+
tree.
243+
244+
If you have any questions or comments about Clang, please feel free to
245+
contact us on the `Discourse forums (Clang Frontend category)
246+
<https://discourse.llvm.org/c/clang/6>`_.

‎flang/docs/ReleaseNotes.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
<!-- If you want to modify sections/contents permanently, you should modify both
2+
ReleaseNotes.md and ReleaseNotesTemplate.txt. -->
3+
14
# Flang |version| (In-Progress) Release Notes
25

36
> **warning**

0 commit comments

Comments
 (0)