52e98cb23f50fffc7dff0cd26690e44bebab1487
[lldb.git] / clang-tools-extra / docs / ReleaseNotes.rst
1 ====================================================
2 Extra Clang Tools 10.0.0 (In-Progress) Release Notes
3 ====================================================
4
5 .. contents::
6    :local:
7    :depth: 3
8
9 Written by the `LLVM Team <https://llvm.org/>`_
10
11 .. warning::
12
13    These are in-progress notes for the upcoming Extra Clang Tools 10 release.
14    Release notes for previous releases can be found on
15    `the Download Page <https://releases.llvm.org/download.html>`_.
16
17 Introduction
18 ============
19
20 This document contains the release notes for the Extra Clang Tools, part of the
21 Clang release 10.0.0. Here we describe the status of the Extra Clang Tools in
22 some detail, including major improvements from the previous release and new
23 feature work. All LLVM releases may be downloaded from the `LLVM releases web
24 site <https://llvm.org/releases/>`_.
25
26 For more information about Clang or LLVM, including information about
27 the latest release, please see the `Clang Web Site <https://clang.llvm.org>`_ or
28 the `LLVM Web Site <https://llvm.org>`_.
29
30 Note that if you are reading this file from a Subversion checkout or the
31 main Clang web page, this document applies to the *next* release, not
32 the current one. To see the release notes for a specific release, please
33 see the `releases page <https://llvm.org/releases/>`_.
34
35 What's New in Extra Clang Tools 10.0.0?
36 =======================================
37
38 Some of the major new features and improvements to Extra Clang Tools are listed
39 here. Generic improvements to Extra Clang Tools as a whole or to its underlying
40 infrastructure are described first, followed by tool-specific sections.
41
42 Major New Features
43 ------------------
44
45 ...
46
47 Improvements to clangd
48 ----------------------
49
50 The improvements are...
51
52 Improvements to clang-doc
53 -------------------------
54
55 - :doc:`clang-doc <clang-doc>` now generates documentation in HTML format.
56
57 Improvements to clang-query
58 ---------------------------
59
60 The improvements are...
61
62 Improvements to clang-rename
63 ----------------------------
64
65 The improvements are...
66
67 Improvements to clang-tidy
68 --------------------------
69
70 New checks
71 ^^^^^^^^^^
72
73 - New :doc:`bugprone-bad-signal-to-kill-thread
74   <clang-tidy/checks/bugprone-bad-signal-to-kill-thread>` check.
75
76   Finds ``pthread_kill`` function calls when a thread is terminated by 
77   raising ``SIGTERM`` signal.
78
79 - New :doc:`bugprone-dynamic-static-initializers
80   <clang-tidy/checks/bugprone-dynamic-static-initializers>` check.
81
82   Finds instances where variables with static storage are initialized
83   dynamically in header files.
84
85 - New :doc:`bugprone-infinite-loop
86   <clang-tidy/checks/bugprone-infinite-loop>` check.
87
88   Finds obvious infinite loops (loops where the condition variable is not
89   changed at all).
90
91 - New :doc:`bugprone-not-null-terminated-result
92   <clang-tidy/checks/bugprone-not-null-terminated-result>` check
93
94   Finds function calls where it is possible to cause a not null-terminated
95   result.
96
97 - New :doc:`bugprone-signed-char-misuse
98   <clang-tidy/checks/bugprone-signed-char-misuse>` check.
99
100   Finds ``signed char`` to integer conversions which might indicate a
101   programming error.
102
103 - New :doc:`cert-mem57-cpp
104   <clang-tidy/checks/cert-mem57-cpp>` check.
105
106   Checks if an object of type with extended alignment is allocated by using
107   the default ``operator new``.
108
109 - New :doc:`cert-oop58-cpp
110   <clang-tidy/checks/cert-oop58-cpp>` check.
111
112   Finds assignments to the copied object and its direct or indirect members
113   in copy constructors and copy assignment operators.
114
115 - New :doc:`cppcoreguidelines-init-variables
116   <clang-tidy/checks/cppcoreguidelines-init-variables>` check.
117
118   Checks whether there are local variables that are declared without an initial
119   value.
120
121 - New :doc:`darwin-dispatch-once-nonstatic
122   <clang-tidy/checks/darwin-dispatch-once-nonstatic>` check.
123
124   Finds declarations of ``dispatch_once_t`` variables without static or global
125   storage.
126
127 - New :doc:`google-upgrade-googletest-case
128   <clang-tidy/checks/google-upgrade-googletest-case>` check.
129
130   Finds uses of deprecated Googletest APIs with names containing ``case`` and
131   replaces them with equivalent APIs with ``suite``.
132
133 - New :doc:`linuxkernel-must-use-errs
134   <clang-tidy/checks/linuxkernel-must-use-errs>` check.
135
136   Checks Linux kernel code to see if it uses the results from the functions in
137   ``linux/err.h``.
138
139 - New :doc:`llvm-prefer-register-over-unsigned
140   <clang-tidy/checks/llvm-prefer-register-over-unsigned>` check.
141
142   Finds historical use of ``unsigned`` to hold vregs and physregs and rewrites
143   them to use ``Register``
144
145 - New :doc:`objc-missing-hash
146   <clang-tidy/checks/objc-missing-hash>` check.
147
148   Finds Objective-C implementations that implement ``-isEqual:`` without also
149   appropriately implementing ``-hash``.
150
151 - New :doc:`performance-no-automatic-move
152   <clang-tidy/checks/performance-no-automatic-move>` check.
153
154   Finds local variables that cannot be automatically moved due to constness.
155
156 - New :doc:`performance-trivially-destructible
157   <clang-tidy/checks/performance-trivially-destructible>` check.
158
159   Finds types that could be made trivially-destructible by removing out-of-line
160   defaulted destructor declarations.
161
162 - New :doc:`readability-make-member-function-const
163   <clang-tidy/checks/readability-make-member-function-const>` check.
164
165   Finds non-static member functions that can be made ``const``
166   because the functions don't use ``this`` in a non-const way.
167
168 - New :doc:`readability-qualified-auto
169   <clang-tidy/checks/readability-qualified-auto>` check.
170
171   Adds pointer and ``const`` qualifications to ``auto``-typed variables 
172   that are deduced to pointers and ``const`` pointers.
173
174 - New :doc:`readability-redundant-access-specifiers
175   <clang-tidy/checks/readability-redundant-access-specifiers>` check.
176
177   Finds classes, structs, and unions that contain redundant member
178   access specifiers.
179
180 New aliases
181 ^^^^^^^^^^^
182
183 - New alias :doc:`cert-pos44-c
184   <clang-tidy/checks/cert-pos44-c>` to
185   :doc:`bugprone-bad-signal-to-kill-thread
186   <clang-tidy/checks/bugprone-bad-signal-to-kill-thread>` was added.
187
188 - New alias :doc:`llvm-qualified-auto
189   <clang-tidy/checks/llvm-qualified-auto>` to
190   :doc:`readability-qualified-auto
191   <clang-tidy/checks/readability-qualified-auto>` was added.
192
193 Changes in existing checks
194 ^^^^^^^^^^^^^^^^^^^^^^^^^^
195
196 - Improved :doc:`bugprone-posix-return
197   <clang-tidy/checks/bugprone-posix-return>` check.
198
199   Now also checks if any calls to ``pthread_*`` functions expect negative
200   return values.
201
202 - Improved :doc:`hicpp-signed-bitwise
203   <clang-tidy/checks/hicpp-signed-bitwise>` check.
204
205   The check now supports the `IgnorePositiveIntegerLiterals` option.
206
207 - Improved :doc:`modernize-avoid-bind
208   <clang-tidy/checks/modernize-avoid-bind>` check.
209
210   The check now supports supports diagnosing and fixing arbitrary callables
211   instead of only simple free functions. The `PermissiveParameterList` option
212   has also been added to address situations where the existing fix-it logic
213   would sometimes generate code that no longer compiles.
214
215 - The :doc:`modernize-use-equals-default
216   <clang-tidy/checks/modernize-use-equals-default>` fix no longer adds
217   semicolons where they would be redundant.
218
219 - Improved :doc:`modernize-use-override
220   <clang-tidy/checks/modernize-use-override>` check.
221
222   The check now supports the `AllowOverrideAndFinal` option to eliminate
223   conflicts with `gcc -Wsuggest-override` or `gcc -Werror=suggest-override`.
224
225 - The :doc:`modernize-use-using
226   <clang-tidy/checks/modernize-use-using>` check now converts typedefs
227   containing struct definitions and multiple comma-separated types.
228
229 - Improved :doc:`readability-magic-numbers
230   <clang-tidy/checks/readability-magic-numbers>` check.
231
232   The check now supports the `IgnoreBitFieldsWidths` option to suppress
233   the warning for numbers used to specify bit field widths.
234
235   The check was updated to eliminate some false positives (such as using
236   class enumeration as non-type template parameters, or the synthetically
237   computed length of a static user string literal.)
238
239 - Improved :doc:`readability-redundant-member-init
240   <clang-tidy/checks/readability-redundant-member-init>` check.
241
242   The check  now supports the `IgnoreBaseInCopyConstructors` option to avoid
243   `"base class 'Foo' should be explicitly initialized in the copy constructor"`
244   warnings or errors with `gcc -Wextra` or `gcc -Werror=extra`.
245
246 - The :doc:`readability-redundant-string-init
247   <clang-tidy/checks/readability-redundant-string-init>` check now supports a
248   `StringNames` option enabling its application to custom string classes.
249
250 Renamed checks
251 ^^^^^^^^^^^^^^
252
253 - The 'objc-avoid-spinlock' check was renamed to :doc:`darwin-avoid-spinlock
254   <clang-tidy/checks/darwin-avoid-spinlock>`
255
256 Improvements to include-fixer
257 -----------------------------
258
259 The improvements are...
260
261 Improvements to clang-include-fixer
262 -----------------------------------
263
264 The improvements are...
265
266 Improvements to modularize
267 --------------------------
268
269 The improvements are...
270
271 Improvements to pp-trace
272 ------------------------
273
274 The improvements are...
275
276 Clang-tidy visual studio plugin
277 -------------------------------
278
279 The clang-tidy-vs plugin has been removed from clang, as
280 it's no longer maintained. Users should migrate to
281 `Clang Power Tools <https://marketplace.visualstudio.com/items?itemName=caphyon.ClangPowerTools>`_
282 instead.