summaryrefslogtreecommitdiffstats
path: root/clang-tools-extra/docs/ReleaseNotes.rst
blob: 813e496e8b5dd8796d95756e43cff4cd71f2b637 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
===================================================
Extra Clang Tools 4.0.0 (In-Progress) Release Notes
===================================================

.. contents::
   :local:
   :depth: 3

Written by the `LLVM Team <http://llvm.org/>`_

.. warning::

   These are in-progress notes for the upcoming Extra Clang Tools 4.0 release.
   You may prefer the `Extra Clang Tools 3.9 Release Notes
   <http://llvm.org/releases/3.9.0/tools/clang/tools/extra/docs/ReleaseNotes.html>`_.

Introduction
============

This document contains the release notes for the Extra Clang Tools, part of the
Clang release 4.0.0. Here we describe the status of the Extra Clang Tools in
some detail, including major improvements from the previous release and new
feature work. All LLVM releases may be downloaded from the `LLVM releases web
site <http://llvm.org/releases/>`_.

For more information about Clang or LLVM, including information about
the latest release, please see the `Clang Web Site <http://clang.llvm.org>`_ or
the `LLVM Web Site <http://llvm.org>`_.

Note that if you are reading this file from a Subversion checkout or the
main Clang web page, this document applies to the *next* release, not
the current one. To see the release notes for a specific release, please
see the `releases page <http://llvm.org/releases/>`_.

What's New in Extra Clang Tools 4.0.0?
======================================

Some of the major new features and improvements to Extra Clang Tools are listed
here. Generic improvements to Extra Clang Tools as a whole or to its underlying
infrastructure are described first, followed by tool-specific sections.

Major New Features
------------------

...

Improvements to clang-query
---------------------------

The improvements are...

Improvements to clang-rename
----------------------------

- Emacs integration was added.

Improvements to clang-tidy
--------------------------

- New `cppcoreguidelines-slicing
  <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-slicing.html>`_ check

  Flags slicing of member variables or vtable.

- New `cppcoreguidelines-special-member-functions
  <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-special-member-functions.html>`_ check

  Flags classes where some, but not all, special member functions are user-defined.

- The UseCERTSemantics option for the `misc-move-constructor-init
  <http://clang.llvm.org/extra/clang-tidy/checks/misc-move-constructor-init.html>`_ check
  has been removed as it duplicated the `modernize-pass-by-value
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-pass-by-value.html>`_ check.

- New `misc-move-forwarding-reference
  <http://clang.llvm.org/extra/clang-tidy/checks/misc-move-forwarding-reference.html>`_ check

  Warns when ``std::move`` is applied to a forwarding reference instead of
  ``std::forward``.

- `misc-pointer-and-integral-operation` check was removed.

- New `misc-string-compare
  <http://clang.llvm.org/extra/clang-tidy/checks/misc-string-compare.html>`_ check

  Warns about using ``compare`` to test for string equality or inequality.

- New `misc-use-after-move
  <http://clang.llvm.org/extra/clang-tidy/checks/misc-use-after-move.html>`_ check

  Warns if an object is used after it has been moved, without an intervening
  reinitialization.

- New `cppcoreguidelines-no-malloc
  <http://clang.llvm.org/extra/clang-tidy/checks/cppcoreguidelines-no-malloc.html>`_ check
  warns if C-style memory management is used and suggests the use of RAII.

- `modernize-make-unique
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-make-unique.html>`_
  and `modernize-make-shared
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-make-shared.html>`_
  now handle calls to the smart pointer's ``reset()`` method.

- The `modernize-pass-by-value
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-pass-by-value.html>`_ check
  now has a ValuesOnly option to only warn about parameters that are passed by
  value but not moved.

- The `modernize-use-auto
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-auto.html>`_ check
  now warns about variable declarations that are initialized with a cast, or by
  calling a templated function that behaves as a cast.

- The modernize-use-default check has been renamed to `modernize-use-equals-default
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-equals-default.html>`_.
  
- New `modernize-use-default-member-init
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-default-member-init.html>`_ check

  Converts a default constructor's member initializers into default member initializers.
  Removes member initializers that are the same as a default member initializer.

- New `modernize-use-equals-delete
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-equals-delete.html>`_ check

  Adds ``= delete`` to unimplemented private special member functions.

- New `modernize-use-transparent-functors
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-use-transparent-functors.html>`_ check

  Replaces uses of non-transparent functors with transparent ones where applicable.

- New `mpi-buffer-deref
  <http://clang.llvm.org/extra/clang-tidy/checks/mpi-buffer-deref.html>`_ check

  Flags buffers which are insufficiently dereferenced when passed to an MPI function call.

- New `mpi-type-mismatch
  <http://clang.llvm.org/extra/clang-tidy/checks/mpi-type-mismatch.html>`_ check

  Flags MPI function calls with a buffer type and MPI data type mismatch.

- New `performance-inefficient-string-concatenation
  <http://clang.llvm.org/extra/clang-tidy/checks/performance-inefficient-string-concatenation.html>`_ check

  Warns about the performance overhead arising from concatenating strings using
  the ``operator+``, instead of ``operator+=``.

- New `performance-type-promotion-in-math-fn
  <http://clang.llvm.org/extra/clang-tidy/checks/performance-type-promotion-in-math-fn.html>`_ check

  Replaces uses of C-style standard math functions with double parameters and float
  arguments with an equivalent function that takes a float parameter.

- `readability-container-size-empty
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-container-size-empty.html>`_ check
  supports arbitrary containers with with suitable ``empty()`` and ``size()``
  methods.

- New `readability-misplaced-array-index
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-misplaced-array-index.html>`_ check

  Warns when there is array index before the [] instead of inside it.

- New `readability-non-const-parameter
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-non-const-parameter.html>`_ check

  Flags function parameters of a pointer type that could be changed to point to
  a constant type instead.

- New `readability-redundant-declaration
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-declaration.html>`_ check

  Finds redundant variable and function declarations.

- New `readability-redundant-function-ptr-dereference
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-function-ptr-dereference.html>`_ check

  Finds redundant function pointer dereferences.

- New `readability-redundant-member-init
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-member-init.html>`_ check

  Flags member initializations that are unnecessary because the same default
  constructor would be called if they were not present.

- The `readability-redundant-string-cstr
  <http://clang.llvm.org/extra/clang-tidy/checks/readability-redundant-string-cstr.html>`_ check
  now warns about redundant calls to data() too.

- The `google-explicit-constructor
  <http://clang.llvm.org/extra/clang-tidy/checks/google-explicit-constructor.html>`_ check
  now warns about conversion operators not marked explicit.

Fixed bugs:

- `modernize-make-unique
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-make-unique.html>`_
  and `modernize-make-shared
  <http://clang.llvm.org/extra/clang-tidy/checks/modernize-make-shared.html>`_
  Calling ``make_{unique|shared}`` from within a member function of a type
  with a private or protected constructor would be ill-formed.

Improvements to include-fixer
-----------------------------

- Emacs integration was added.

Improvements to modularize
--------------------------

The improvements are...
OpenPOWER on IntegriCloud