Commit a4f9cf0b authored by Oleg Grenrus's avatar Oleg Grenrus

Cleanup the documentation a bit

parent 4d72925a
......@@ -632,21 +632,21 @@ Test-suite fields
main-is
* Optional field
* Documentation of :pkg-field:`main-is`
* Documentation of :pkg-field:`test-suite:main-is`
.. math::
\left\{ \mathop{\mathit{hs\text{-}string}}\mid{{[\mathop{\mathord{``}\mathtt{\ }\mathord{"}}\mathop{\mathord{``}\mathtt{\text{,}}\mathord{"}}]^c}}^+_{} \right\}
test-module
* Optional field
* Documentation of :pkg-field:`test-module`
* Documentation of :pkg-field:`test-suite:test-module`
.. math::
{\left(\mathop{\mathit{upper}}{\left\{ \mathop{\mathit{alpha\text{-}num}}\mid[\mathop{\mathord{``}\mathtt{\text{'}}\mathord{"}}\mathop{\mathord{``}\mathtt{\text{_}}\mathord{"}}] \right\}}^\ast_{}\right)}^+_{\mathop{\mathord{``}\mathtt{\text{.}}\mathord{"}}}
type
* Optional field
* Documentation of :pkg-field:`type`
* Documentation of :pkg-field:`test-suite:type`
.. math::
\left\{ \mathop{\mathord{``}\mathtt{exitcode\text{-}stdio\text{-}1\text{.}0}\mathord{"}}\mid\mathop{\mathord{``}\mathtt{detailed\text{-}0\text{.}9}\mathord{"}} \right\}
......
......@@ -1623,7 +1623,7 @@ system-dependent values for these fields.
The subtle but important difference in signaling allows tooling to
treat explicitly expressed ``<``-style constraints and inferred
(``^>=``-style) upper bounds differently. For instance,
:option:`--allow-newer`'s ``^``-modifier allows to relax only
:cfg-field:`allow-newer`'s ``^``-modifier allows to relax only
``^>=``-style bounds while leaving explicitly stated
``<``-constraints unaffected.
......@@ -1725,6 +1725,7 @@ system-dependent values for these fields.
compiled twice, once as part of the library and again for the executable.
.. pkg-field:: default-extensions: identifier list
:since: 1.12
A list of Haskell extensions used by every module. These determine
corresponding compiler options enabled for all files. Extension
......@@ -1734,6 +1735,7 @@ system-dependent values for these fields.
to be preprocessed with a C preprocessor.
.. pkg-field:: other-extensions: identifier list
:since: 1.12
A list of Haskell extensions used by some (but not necessarily all)
modules. From GHC version 6.6 onward, these may be specified by
......@@ -1761,6 +1763,16 @@ system-dependent values for these fields.
for information only, but it is recommended to replicate them in
:pkg-field:`other-extensions` declarations.
.. pkg-field:: default-language: identifier
:since: 1.12
TBW
.. pkg-field:: other-languages: identifier
:since: 1.12
TBW
.. pkg-field:: extensions: identifier list
:deprecated: 1.12
:removed: 3.0
......@@ -1941,6 +1953,18 @@ system-dependent values for these fields.
ones specified via :pkg-field:`ghc-options`, and are passed to GHC during
both the compile and link phases.
.. pkg-field:: ghcjs-options: token list
Like :pkg-field:`ghc-options` but applies to GHCJS
.. pkg-field:: ghcjs-prof-options: token list
Like :pkg-field:`ghc-prof-options` but applies to GHCJS
.. pkg-field:: ghcjs-shared-options: token list
Like :pkg-field:`ghc-shared-options` but applies to GHCJS
.. pkg-field:: includes: filename list
A list of header files to be included in any compilations via C.
......@@ -2057,6 +2081,14 @@ system-dependent values for these fields.
A list of directories to search for libraries.
.. pkg-field:: extra-library-flavours: notsure
TBW
.. pkg-field:: extra-dynamic-library-flavours: notsure
TBW
.. pkg-field:: cc-options: token list
Command-line arguments to be passed to the C compiler. Since the
......@@ -2616,6 +2648,12 @@ Starting with Cabal-2.2 it's possible to use common build info stanzas.
The name `import` was chosen, because there is ``includes`` field.
.. pkg-section:: None
.. pkg-field:: import: token-list
TBW
Source Repositories
^^^^^^^^^^^^^^^^^^^
......@@ -2883,6 +2921,8 @@ is to distinguish ``Cabal < 2.0`` from ``Cabal >= 2.0``.
Autogenerated modules and includes
----------------------------------
.. pkg-section:: None
Modules that are built automatically at setup, created with a custom
setup script, must appear on :pkg-field:`other-modules` for the library,
executable, test-suite or benchmark stanzas or also on
......@@ -2933,6 +2973,18 @@ Right now :pkg-field:`executable:main-is` modules are not supported on
(e.g. by a ``configure`` script). Autogenerated header files are not
packaged by ``sdist`` command.
Virtual modules
---------------
TBW
.. pkg-field:: virtual-modules: module list
:since: 2.2
TBW
Accessing data files from package code
--------------------------------------
......
......@@ -143,7 +143,7 @@ Formally, the format is described by the following BNF:
Specifying Packages from Remote Version Control Locations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Starting with Cabal 2.4, there is now a stanza
``source-repository-package`` for specifying packages from an external
......
......@@ -99,12 +99,12 @@ mathjax_path = 'https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js?c
latex_elements = {
'inputenc': '',
'utf8extra': '',
'preamble': '''
\\usepackage{fontspec}
\\usepackage{makeidx}
\\setsansfont{DejaVu Sans}
\\setromanfont{DejaVu Serif}
\\setmonofont{DejaVu Sans Mono}
'preamble': r'''
\usepackage{fontspec}
\usepackage{makeidx}
\setsansfont{DejaVu Sans}
\setromanfont{DejaVu Serif}
\setmonofont{DejaVu Sans Mono}
''',
}
......
......@@ -221,7 +221,7 @@ Test-suite fields
{# We show documentation link only for non deprecated fields #}
{% if null field.deprecatedSince.fst %}
{% if null field.removedIn.fst %}
* Documentation of :pkg-field:`{{field.name}}`
* Documentation of :pkg-field:`test-suite:{{field.name}}`
{% endif %}
{% endif %}
{% if notNull field.syntax %}
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment