Add -Wcpp-undef warning flag
[ghc.git] / docs / users_guide / 8.2.1-notes.rst
1 .. _release-8-2-1:
2
3 Release notes for version 8.2.1
4 ===============================
5
6 The significant changes to the various parts of the compiler are listed
7 in the following sections. There have also been numerous bug fixes and
8 performance improvements over the 8.0 branch.
9
10 Highlights
11 ----------
12
13 The highlights since the 8.0 branch are:
14
15 - TODO FIXME
16 - SCC annotations can now be used for declarations.
17
18 Full details
19 ------------
20
21 Language
22 ~~~~~~~~
23
24 -  TODO FIXME.
25
26 - Pattern synonym signatures can now be applied to multiple patterns, just like
27   value-level binding signatures. See :ref:`patsyn-typing` for details.
28
29 Compiler
30 ~~~~~~~~
31
32 -  TODO FIXME.
33
34 - Old profiling flags ``-auto-all``, ``-auto``, and ``-caf-all`` are deprecated
35   and their usage provokes a compile-time warning.
36
37 - Support for adding cost centres to declarations is added. The same `SCC`
38   syntax can be used, in addition to a new form for specifying the cost centre
39   name. See :ref:`scc-pragma` for examples.
40
41 - It is now possible to explicitly pick a strategy to use when deriving a
42   class instance using the :ghc-flag:`-XDerivingStrategies` language extension
43   (see :ref:`deriving-strategies`).
44
45 - GHC now allows standalone deriving using :ghc-flag:`-XDeriveAnyClass` on
46   any data type, even if its data constructors are not in scope. This is
47   consistent with the fact that this code (in the presence of
48   :ghc-flag:`-XDeriveAnyClass`): ::
49
50       deriving instance C T
51
52   is exactly equivalent to: ::
53
54       instance C T
55
56   and the latter code has no restrictions about whether the data constructors
57   of ``T`` are in scope.
58
59 - Add warning flag :ghc-flag:`-Wcpp-undef` which passes ``-Wundef`` to the C
60   pre-processor causing the pre-processor to warn on uses of the ``#if``
61   directive on undefined identifiers.
62
63 GHCi
64 ~~~~
65
66 -  TODO FIXME.
67
68 - Added :ghc-flag:`-flocal-ghci-history` which uses current directory for `.ghci-history`.
69
70 Template Haskell
71 ~~~~~~~~~~~~~~~~
72
73 -  TODO FIXME.
74
75 -  Reifying types that contain unboxed tuples now works correctly. (Previously,
76    Template Haskell reified unboxed tuples as boxed tuples with twice their
77    appropriate arity.)
78
79 -  Splicing singleton unboxed tuple types (e.g., ``(# Int #)``) now works
80    correctly. Previously, Template Haskell would implicitly remove the
81    parentheses when splicing, which would turn ``(# Int #)`` into ``Int``.
82
83 Runtime system
84 ~~~~~~~~~~~~~~
85
86 -  TODO FIXME.
87
88 - The :ref:`heap profiler <prof-heap>` can now emit heap census data to the GHC
89   event log, allowing heap profiles to be correlated with other tracing events
90   (see :ghc-ticket:`11094`).
91
92 - Added NUMA support to Windows.
93
94 - Added processor group support for Windows. This allows the runtime to allocate
95   threads to all cores in systems which have multiple processor groups.
96   (e.g. > 64 cores, see :ghc-ticket:`11054`)
97
98 Build system
99 ~~~~~~~~~~~~
100
101 -  TODO FIXME.
102
103 Package system
104 ~~~~~~~~~~~~~~
105
106 -  TODO FIXME.
107
108 hsc2hs
109 ~~~~~~
110
111 -  TODO FIXME.
112
113 Libraries
114 ---------
115
116 array
117 ~~~~~
118
119 -  Version number XXXXX (was 0.5.0.0)
120
121
122 .. _lib-base:
123
124 base
125 ~~~~
126
127 See ``changelog.md`` in the ``base`` package for full release notes.
128
129 -  Version number 4.10.0.0 (was 4.9.0.0)
130
131 - ``Data.Either`` now provides ``fromLeft`` and ``fromRight``
132
133 - ``Data.Type.Coercion`` now provides ``gcoerceWith``, which is analogous to
134   ``gcastWith`` from ``Data.Type.Equality``.
135
136 - The ``Read1`` and ``Read2`` classes in ``Data.Functor.Classes`` have new
137   methods, ``liftReadList(2)`` and ``liftReadListPrec(2)``, that are defined in
138   terms of ``ReadPrec`` instead of ``ReadS``. This matches the interface
139   provided in GHC's version of the ``Read`` class, and allows users to write
140   more efficient ``Read1`` and ``Read2`` instances.
141
142 binary
143 ~~~~~~
144
145 -  Version number XXXXX (was 0.7.1.0)
146
147 bytestring
148 ~~~~~~~~~~
149
150 -  Version number XXXXX (was 0.10.4.0)
151
152 Cabal
153 ~~~~~
154
155 -  Version number XXXXX (was 1.18.1.3)
156
157 containers
158 ~~~~~~~~~~
159
160 -  Version number XXXXX (was 0.5.4.0)
161
162 deepseq
163 ~~~~~~~
164
165 -  Version number XXXXX (was 1.3.0.2)
166
167 directory
168 ~~~~~~~~~
169
170 -  Version number XXXXX (was 1.2.0.2)
171
172 filepath
173 ~~~~~~~~
174
175 -  Version number XXXXX (was 1.3.0.2)
176
177 ghc
178 ~~~
179
180 -
181 ghc-boot
182 ~~~~~~~~
183
184 -  This is an internal package. Use with caution.
185
186 -  TODO FIXME.
187
188 ghc-prim
189 ~~~~~~~~
190
191 -  Version number XXXXX (was 0.3.1.0)
192
193 -  Added new ``isByteArrayPinned#`` and ``isMutableByteArrayPinned#`` operation.
194
195 -  New function ``noinline`` in ``GHC.Magic`` lets you mark that a function
196    should not be inlined.  It is optimized away after the simplifier runs.
197
198 haskell98
199 ~~~~~~~~~
200
201 -  Version number XXXXX (was 2.0.0.3)
202
203 haskell2010
204 ~~~~~~~~~~~
205
206 -  Version number XXXXX (was 1.1.1.1)
207
208 hoopl
209 ~~~~~
210
211 -  Version number XXXXX (was 3.10.0.0)
212
213 hpc
214 ~~~
215
216 -  Version number XXXXX (was 0.6.0.1)
217
218 integer-gmp
219 ~~~~~~~~~~~
220
221 -  Version number XXXXX (was 0.5.1.0)
222
223 old-locale
224 ~~~~~~~~~~
225
226 -  Version number XXXXX (was 1.0.0.6)
227
228 old-time
229 ~~~~~~~~
230
231 -  Version number XXXXX (was 1.1.0.2)
232
233 process
234 ~~~~~~~
235
236 -  Version number XXXXX (was 1.2.0.0)
237
238 template-haskell
239 ~~~~~~~~~~~~~~~~
240
241 -  Version number XXXXX (was 2.9.0.0)
242
243 -  Added support for unboxed sums :ghc-ticket:`12478`.
244
245 -  Added support for visible type applications :ghc-ticket:`12530`.
246
247 time
248 ~~~~
249
250 -  Version number XXXXX (was 1.4.1)
251
252 unix
253 ~~~~
254
255 -  Version number XXXXX (was 2.7.0.0)
256
257 Win32
258 ~~~~~
259
260 -  Version number XXXXX (was 2.3.0.1)
261
262 Known bugs
263 ----------
264
265 -  TODO FIXME