diff options
| author | Joachim Breitner <mail@joachim-breitner.de> | 2017-10-19 14:21:49 -0400 |
|---|---|---|
| committer | Joachim Breitner <mail@joachim-breitner.de> | 2017-10-23 09:14:47 -0400 |
| commit | 1db8aecc849658732b6b3035b6b30606725fbd65 (patch) | |
| tree | 05c52fefe87b6fcdbc4f8e317c2b8fcafe57679d /docs/users_guide/flags.rst | |
| parent | 052ec24412e285aa34911d6187cc2227fc7d86d9 (diff) | |
| download | haskell-wip/D4112.tar.gz | |
Make language extensions their own category in the documentationwip/D4112
I.e. instead of
.. ghc-flag:: -XUnboxedTuples
:shortdesc: Enable the use of unboxed tuple syntax.
:type: dynamic
:reverse: -XNoUnboxedTuples
:category:
one simply writes
.. extension:: UnboxedTuples
:shortdesc: Enable the use of unboxed tuple syntax.
This allows language extensions to be referenced as
If :extension:`UnboxedTuples` is enabled, then...
This directive still creates the entries for the `-XUnboxedTuples` flag,
so in particular,
Set :ghc-flag:`-XUnboxedTuples` if you have to.
still works, and lists of flags in general (e.g. for the manpage)
include these.
I also removed lots of links from the shortdesc of the extensions, when
this link simply points to the section where the extension is defined.
I removed the list of `-X` flags from the flag reference table, but added a
table of extension under “10.1. Language options”
Lots of text in the manual now refers to “extension `Foo`” rather than
“flag `-XFoo`”.
I consider `-XFoo` a historic artifact that stems from when language
extensions were really just flags. These days, the use of `-XFoo` is
(IMHO) deprecated: You should be using `LANGUAGE Foo`, or maybe the
appropriate field in a `.cabal` file. See 9278994 which did this change
to error messages already.
Diffstat (limited to 'docs/users_guide/flags.rst')
| -rw-r--r-- | docs/users_guide/flags.rst | 11 |
1 files changed, 0 insertions, 11 deletions
diff --git a/docs/users_guide/flags.rst b/docs/users_guide/flags.rst index ce3244b153..2d5d5c4a95 100644 --- a/docs/users_guide/flags.rst +++ b/docs/users_guide/flags.rst @@ -175,8 +175,6 @@ More details in :ref:`packages` :category: packages -.. flags-language-options:: - Language options ---------------- @@ -184,15 +182,6 @@ Language options can be enabled either by a command-line option ``-Xblah``, or by a ``{-# LANGUAGE blah #-}`` pragma in the file itself. See :ref:`options-language`. -.. tabularcolumns:: - | p{\dimexpr 0.36\textwidth-2\tabcolsep} | - p{\dimexpr 0.25\textwidth-2\tabcolsep} | - p{\dimexpr 0.11\textwidth-2\tabcolsep} | - p{\dimexpr 0.29\textwidth-2\tabcolsep} | - -.. flag-print:: - :type: table - :category: language Warnings -------- |