Skip to content

Commit 1cec7c8

Browse files
committed
Take format specification history back to Cabal-1.0
1 parent 091f61a commit 1cec7c8

File tree

1 file changed

+104
-0
lines changed

1 file changed

+104
-0
lines changed

doc/file-format-changelog.rst

+104
Original file line numberDiff line numberDiff line change
@@ -343,4 +343,108 @@ relative to the respective preceding *published* version.
343343
* New :pkg-field:`license` types ``MIT`` and versioned ``GPL`` and ``LGPL``
344344
added.
345345

346+
``cabal-version: ==1.6``
347+
------------------------
348+
349+
* New :pkg-section:`source-repository` stanza for information about the
350+
location of the package's source code within a source code repository.
351+
352+
* Add support for new :pkg-field:`bug-reports` field, to specify the URL where
353+
users should direct bug reports.
354+
355+
* Add support for wildcards in :pkg-field:`data-files` and
356+
:pkg-field:`extra-source-files` fields.
357+
358+
* Add support for ``foo ==1.2.*`` syntax to :pkg-field:`build-depends` field.
359+
360+
* Add support for new :pkg-field:`exposed` field (default: ``True``), to be able
361+
to specify that the package should not be exposed.
362+
363+
* :pkg-field:`cpp-options`, :pkg-field:`cc-options` and :pkg-field:`ld-options`
364+
fields no longer use ``,`` as a separator.
365+
366+
``cabal-version: ==1.2.1``
367+
--------------------------
368+
369+
* New format for the :pkg-section:`flag`, :pkg-section:`library` and
370+
:pkg-section:`executable` stanzas.
371+
372+
* Add support for new :pkg-field:`cpp-options` field, to specify options used
373+
when pre-processing Haskell modules.
374+
375+
* Replace :pkg-field:`nhc-options` field with :pkg-field:`nhc98-options` field.
376+
377+
``cabal-version: ==1.2.0``
378+
--------------------------
379+
380+
* The :pkg-field:`cabal-version` field is now required.
381+
382+
* New :pkg-section:`flag` stanza for specifying configuration flags and add
383+
support for conditional blocks in :pkg-section:`library` and
384+
:pkg-section:`executable` stanzas.
385+
386+
* Add distinct :pkg-section:`library` stanza.
387+
388+
* New format for :pkg-section:`executable` stanzas.
389+
390+
* Add support for new :pkg-field:`build-type` field (default: ``Custom``), to
391+
specify the type of build used by this package.
392+
393+
* Add support for new :pkg-field:`build-tools` field, to specify tools needed to
394+
build the package.
395+
396+
* Add support for new :pkg-field:`pkgconfig-depends` field, to specify
397+
``pkg-config`` packages needed to build the package.
398+
399+
* Add support for new :pkg-field:`ghc-shared-options` field, to specify
400+
additional options for GHC when the package is built as a shared library.
401+
402+
``cabal-version: ==1.1.6``
403+
--------------------------
404+
405+
* Add support for new :pkg-field:`install-includes` field, distinct from the
406+
:pkg-field:`includes` field, to specify header files from the package.
407+
408+
* Add support for new :pkg-field:`jhc-options` field, to specify additional
409+
options for John Meacham's Haskell compiler (JHC).
410+
411+
``cabal-version: ==1.1.4``
412+
--------------------------
413+
414+
* Add support for new optional :pkg-field:`cabal-version` field, to specify the
415+
version of ``Cabal`` required for the package.
416+
417+
* Add support for new :pkg-field:`author`, :pkg-field:`homepage`,
418+
:pkg-field:`package-url`, :pkg-field:`synopsis`, :pkg-field:`description` and
419+
:pkg-field:`category` fields.
420+
421+
* Add support for new :pkg-field:`tested-with` field to specify compilers and
422+
versions against which the package has been tested.
423+
424+
* Add support for new :pkg-field:`data-files` field to specify files for use by
425+
the package at run-time.
426+
427+
* Add support for new :pkg-field:`extra-source-files` field to specify files to
428+
be included in source distributions.
429+
430+
* Add support for new :pkg-field:`extra-tmp-files` field to specify files to
431+
be removed when cleaning up.
432+
433+
* Replace :pkg-field:`hs-source-dir` field with :pkg-field:`hs-source-dirs`
434+
field.
435+
436+
* Add support for new :pkg-field:`ghc-prof-options` field, to specify
437+
additional options for GHC when the package is built with profiling.
438+
439+
* Add support for extension fields beginning with :pkg-field:`x-`.
440+
441+
``Cabal-1.0``
442+
-------------
443+
444+
``Cabal-1.0``, released March 2005, came with a
445+
`specification <https://downloads.haskell.org/~cabal/Cabal-1.0/doc/pkg-spec-html/>`__
446+
for 'The Haskell Cabal: A Common Architecture for Building Applications and
447+
Tools', including `Section 5.2 <https://downloads.haskell.org/~cabal/Cabal-1.0/doc/pkg-spec-html/x611.html#SBI-PKG-DESC>`__
448+
'Package description in the simple build infrastructure'.
449+
346450
.. include:: references.inc

0 commit comments

Comments
 (0)