rts: Kill PAPI support
[ghc.git] / docs / users_guide / 7.12.1-notes.rst
1 .. _release-7-12-1:
2
3 Release notes for version 7.12.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 7.10 branch.
9
10 Highlights
11 ----------
12
13 The highlights, since the 7.10 branch, are:
14
15 -  TODO FIXME
16
17 Full details
18 ------------
19
20 Language
21 ~~~~~~~~
22
23 -  TODO FIXME.
24
25 -  The parser now supports Haddock comments on GADT data constructors.
26    For example,
27
28    ::
29
30                              data Expr a where
31                                -- | Just a normal sum
32                                Sum :: Int -> Int -> Expr Int
33
34 -  Implicit parameters of the new ghc-prim type ``GHC.Types.CallStack``
35    are treated specially, and automatically solved for the current
36    source location. For example
37
38    ::
39
40                              f = print (?stk :: CallStack)
41
42    will print the singleton stack containing the occurrence of ``?stk``.
43    If there is another ``CallStack`` implicit in-scope, the new location
44    will be appended to the existing stack, e.g.
45
46    ::
47
48                              f :: (?stk :: CallStack) => IO ()
49                              f = print (?stk :: CallStack)
50
51    will print the occurrence of ``?stk`` and the call-site of ``f``. The
52    name of the implicit parameter does not matter.
53
54    See the release notes for ghc-prim for a description of the
55    ``CallStack`` type.
56
57 -  To conform to the common case, the default role assigned to
58    parameters of datatypes declared in ``hs-boot`` files is
59    ``representational``. However, if the constructor(s) for the datatype
60    are given, it makes sense to do normal role inference. This is now
61    implemented, effectively making the default role for non-abstract
62    datatypes in ``hs-boot`` files to be ``phantom``, like it is in
63    regular Haskell code.
64
65 -  Wildcards can be used in the type arguments of type/data family
66    instance declarations to indicate that the name of a type variable
67    doesn't matter. They will be replaced with new unique type variables.
68    See :ref:`data-instance-declarations` for more details.
69
70 -  GHC now allows to declare type families as injective. Injectivity
71    information can then be used by the typechecker. See
72    :ref:`injective-ty-fams` for details.
73
74 -  Due to a :ghc-ticket:`security issue <10826>`, Safe Haskell now forbids
75    annotations in programs marked as ``-XSafe``.
76
77 -  Generic instances can be derived for data types whose constructors have
78    arguments with certain unlifted types. See :ref:`generic-programming` for
79    more details.
80
81 -  The ``-XDeriveAnyClass`` extension now fills in associated type family
82    default instances when deriving a class that contains them.
83
84 Compiler
85 ~~~~~~~~
86
87 -  Added the option ``-dth-dec-file``. This dumps out a .th.hs file of
88    all Template Haskell declarations in a corresponding .hs file. The
89    idea is that application developers can check this into their
90    repository so that they can grep for identifiers used elsewhere that
91    were defined in Template Haskell. This is similar to using
92    ``-ddump-to-file`` with ``-ddump-splices`` but it always generates a
93    file instead of being coupled to ``-ddump-to-file`` and only outputs
94    code that does not exist in the .hs file and a comment for the splice
95    location in the original file.
96
97 -  Added the option ``-fprint-expanded-types``. When enabled, GHC also
98    prints type-synonym-expanded types in type errors.
99
100 -  Added the option ``-fcpr-anal``. When enabled, the demand analyser
101    performs CPR analysis. It is implied by ``-O``. Consequently,
102    ``-fcpr-off`` is now removed, run with ``-fno-cpr-anal`` to get the
103    old ``-fcpr-off`` behaviour.
104
105 -  Added the option ``-fworker-wrapper``. When enabled, the worker-wrapper
106    transformation is performed after a strictness analysis pass. It is implied
107    by ``-O`` and by ``-fstrictness``. It is disabled by ``-fno-strictness``.
108    Enabling ``-fworker-wrapper`` while strictness analysis is disabled (by
109    ``-fno-strictness``) has no effect.
110
111 -  Added the options ``-fwarn-missed-specialisations`` and
112    ``-fwarn-all-missed-specialisations``. When enabled, the simplifier will
113    produce a warning when a overloaded imported function cannot be
114    specialised (typically due to a missing ``INLINEABLE`` pragma). This
115    is intended to alert users to cases where they apply ``INLINEABLE`` but
116    may not get the speed-up they expect.
117
118 GHCi
119 ~~~~
120
121 -  ``Main`` with an explicit module header but without ``main`` is now
122    an error (#7765).
123
124 -  The ``:back`` and ``:forward`` commands now take an optional count
125    allowing the user to move forward or backward in history several
126    steps at a time.
127
128 -  Added commands ``:load!`` and ``:reload!``, effectively setting
129    "-fdefer-type-errors" before loading a module and unsetting it after
130    loading if it has not been set before (#8353).
131
132 -  ``ghci -e`` now behaves like ``ghc -e`` (#9360).
133
134 Template Haskell
135 ~~~~~~~~~~~~~~~~
136
137 -  The ``TemplateHaskell`` now no longer automatically errors when used
138    with a stage 1 compiler (i.e. GHC without interpreter support); in
139    particular, plain Haskell quotes (not quasi-quotes) can now be
140    compiled without erroring. Splices and quasi-quotes continue to only
141    be supported by a stage 2 compiler.
142
143 -  Partial type signatures can now be used in splices, see
144    :ref:`pts-where`.
145
146 -  ``Template Haskell`` now fully supports typed holes and quoting unbound
147    variables.  This means it is now possible to use pattern splices nested
148    inside quotation brackets.
149
150 -  ``Template Haskell`` now supports the use of ``UInfixT`` in types to
151    resolve infix operator fixities, in the same vein as ``UInfixP`` and
152    ``UInfixE`` in patterns and expressions. ``ParensT`` and ``InfixT``
153    have also been introduced, serving the same functions as their
154    pattern and expression counterparts.
155
156 -  Primitive chars (e.g., ``[| 'a'# |]``) and primitive strings (e.g.,
157    ``[| "abc"# |]``) can now be quoted with Template Haskell. The
158    ``Lit`` data type also has a new constructor, ``CharPrimL``, for
159    primitive char literals.
160
161 -  ``addTopDecls`` now accepts annotation pragmas.
162
163 -  Internally, the implementation of quasi-quotes has been unified with
164    that of normal Template Haskell splices. Under the previous
165    implementation, top-level declaration quasi-quotes did not cause a
166    break in the declaration groups, unlike splices of the form
167    ``$(...)``. This behavior has been preserved under the new
168    implementation, and is now recognized and documented in
169    :ref:`th-syntax`.
170
171 -  The ``Lift`` class is now derivable via the ``-XDeriveLift`` extension. See
172    :ref:`deriving-lift` for more information.
173
174
175 Runtime system
176 ~~~~~~~~~~~~~~
177
178 -  Support for performance monitoring with PAPI has been dropped.
179
180 Build system
181 ~~~~~~~~~~~~
182
183 -  TODO FIXME.
184
185 Package system
186 ~~~~~~~~~~~~~~
187
188 -  TODO FIXME.
189
190 Libraries
191 ---------
192
193 array
194 ~~~~~
195
196 -  Version number XXXXX (was 0.5.0.0)
197
198 base
199 ~~~~
200
201 -  Version number XXXXX (was 4.7.0.0)
202
203 -  A new module ``GHC.SrcLoc`` was added, exporting a new type
204    ``SrcLoc``. A ``SrcLoc`` contains package, module, and file names, as
205    well as start and end positions.
206
207 -  A new type ``CallStack`` was added for use with the new implicit
208    callstack parameters. A ``CallStack`` is a ``[(String, SrcLoc)]``,
209    sorted by most-recent call.
210
211 -  A new function, ``interruptible``, was added to ``GHC.IO`` allowing
212    an ``IO`` action to be run such that it can be interrupted by an
213    asynchronous exception, even if exceptions are masked (except if
214    masked with ``interruptibleMask``).
215
216    This was introduced to fix the behavior of ``allowInterrupt``, which
217    would previously incorrectly allow exceptions in uninterruptible
218    regions (see :ghc-ticket:`9516`).
219
220 -  Per-thread allocation counters (``setAllocationCounter`` and
221    ``getAllocationCounter``) and limits (``enableAllocationLimit``,
222    ``disableAllocationLimit`` are now available from ``System.Mem``. Previously
223    this functionality was only available from ``GHC.Conc``.
224
225 - ``forever``, ``filterM``, ``mapAndUnzipM``, ``zipWithM``, ``zipWithM_``,
226   ``replicateM``, and ``replicateM`` were generalized from ``Monad`` to
227   ``Applicative``. If this causes performance regressions, try to make the
228   implementation of ``(*>)`` match that of ``(>>)``.
229
230
231 binary
232 ~~~~~~
233
234 -  Version number XXXXX (was 0.7.1.0)
235
236 bytestring
237 ~~~~~~~~~~
238
239 -  Version number XXXXX (was 0.10.4.0)
240
241 Cabal
242 ~~~~~
243
244 -  Version number XXXXX (was 1.18.1.3)
245
246 containers
247 ~~~~~~~~~~
248
249 -  Version number XXXXX (was 0.5.4.0)
250
251 deepseq
252 ~~~~~~~
253
254 -  Version number XXXXX (was 1.3.0.2)
255
256 directory
257 ~~~~~~~~~
258
259 -  Version number XXXXX (was 1.2.0.2)
260
261 filepath
262 ~~~~~~~~
263
264 -  Version number XXXXX (was 1.3.0.2)
265
266 ghc
267 ~~~
268
269 -  TODO FIXME.
270
271 -  The ``HsBang`` type has been removed in favour of ``HsSrcBang`` and
272    ``HsImplBang``. Data constructors now always carry around their
273    strictness annotations as the user wrote them, whether from an
274    imported module or not.
275
276 -  Moved `startsVarSym`, `startsVarId`, `startsConSym`, `startsConId`,
277    `startsVarSymASCII`, and `isVarSymChar` from `Lexeme` to the `GHC.Lemexe`
278    module of the `ghc-boot` library.
279
280 ghc-boot
281 ~~~~~~~~
282
283 -  This is an internal package. Use with caution.
284
285 -  This package was renamed from `bin-package-db` to reflect its new purpose
286    of containing intra-GHC functionality that needs to be shared across
287    multiple GHC boot libraries.
288
289 -  Added `GHC.Lexeme`, which contains functions for determining if a
290    character can be the first letter of a variable or data constructor in
291    Haskell, as defined by GHC. (These functions were moved from `Lexeme`
292    in `ghc`.)
293
294 ghc-prim
295 ~~~~~~~~
296
297 -  Version number XXXXX (was 0.3.1.0)
298
299 haskell98
300 ~~~~~~~~~
301
302 -  Version number XXXXX (was 2.0.0.3)
303
304 haskell2010
305 ~~~~~~~~~~~
306
307 -  Version number XXXXX (was 1.1.1.1)
308
309 hoopl
310 ~~~~~
311
312 -  Version number XXXXX (was 3.10.0.0)
313
314 hpc
315 ~~~
316
317 -  Version number XXXXX (was 0.6.0.1)
318
319 integer-gmp
320 ~~~~~~~~~~~
321
322 -  Version number XXXXX (was 0.5.1.0)
323
324 old-locale
325 ~~~~~~~~~~
326
327 -  Version number XXXXX (was 1.0.0.6)
328
329 old-time
330 ~~~~~~~~
331
332 -  Version number XXXXX (was 1.1.0.2)
333
334 process
335 ~~~~~~~
336
337 -  Version number XXXXX (was 1.2.0.0)
338
339 template-haskell
340 ~~~~~~~~~~~~~~~~
341
342 -  Version number XXXXX (was 2.9.0.0)
343
344 -  The ``Lift`` type class for lifting values into Template Haskell
345    splices now has a default signature ``lift :: Data a => a -> Q Exp``,
346    which means that you do not have to provide an explicit
347    implementation of ``lift`` for types which have a ``Data`` instance.
348    To manually use this default implementation, you can use the
349    ``liftData`` function which is now exported from
350    ``Language.Haskell.TH.Syntax``.
351
352 -  ``Info``'s constructors no longer have ``Fixity`` fields. A
353    ``qReifyFixity`` function was added to the ``Quasi`` type class (as
354    well as the ``reifyFixity`` function, specialized for ``Q``) to allow
355    lookup of fixity information for any given ``Name``.
356
357 time
358 ~~~~
359
360 -  Version number XXXXX (was 1.4.1)
361
362 unix
363 ~~~~
364
365 -  Version number XXXXX (was 2.7.0.0)
366
367 Win32
368 ~~~~~
369
370 -  Version number XXXXX (was 2.3.0.1)
371
372 Known bugs
373 ----------
374
375 -  TODO FIXME