summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoachim Breitner <mail@joachim-breitner.de>2017-10-19 11:45:19 -0400
committerJoachim Breitner <mail@joachim-breitner.de>2017-10-19 11:55:46 -0400
commit7ac22b73b38b60bc26ad2508f57732aa17532a80 (patch)
treefcba48f6072c33e46f142b473d79a0d5f69f7944
parentde8752e40bfdb05727c723abf97bdf158b5d9392 (diff)
downloadhaskell-7ac22b73b38b60bc26ad2508f57732aa17532a80.tar.gz
User's guide: Fix the category of some flags
so now “7.6.12. Language options” only lists `-X` flags, as it should.
-rw-r--r--docs/users_guide/flags.rst6
-rw-r--r--docs/users_guide/glasgow_exts.rst8
-rw-r--r--docs/users_guide/phases.rst2
-rw-r--r--docs/users_guide/safe_haskell.rst14
4 files changed, 17 insertions, 13 deletions
diff --git a/docs/users_guide/flags.rst b/docs/users_guide/flags.rst
index a3ec0f6f9e..ce3244b153 100644
--- a/docs/users_guide/flags.rst
+++ b/docs/users_guide/flags.rst
@@ -174,13 +174,15 @@ More details in :ref:`packages`
:type: table
:category: packages
+
+.. flags-language-options::
+
Language options
----------------
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`. Some options are enabled using ``-f*``
-flags.
+See :ref:`options-language`.
.. tabularcolumns::
| p{\dimexpr 0.36\textwidth-2\tabcolsep} |
diff --git a/docs/users_guide/glasgow_exts.rst b/docs/users_guide/glasgow_exts.rst
index d0e079eb05..24992871cf 100644
--- a/docs/users_guide/glasgow_exts.rst
+++ b/docs/users_guide/glasgow_exts.rst
@@ -44,6 +44,7 @@ Language options can be controlled in two ways:
``LANGUAGE`` pragma, thus ``{-# LANGUAGE TemplateHaskell #-}`` (see
:ref:`language-pragma`).
+A compact list of all language options can be found in the `flags reference section <#flags-language-options>`__.
Although not recommended, the deprecated :ghc-flag:`-fglasgow-exts` flag enables
a large swath of the extensions supported by GHC at once.
@@ -53,7 +54,7 @@ a large swath of the extensions supported by GHC at once.
see :ref:`options-language` for exactly which ones.
:type: dynamic
:reverse: -fno-glasgow-exts
- :category:
+ :category: misc
The flag ``-fglasgow-exts`` is equivalent to enabling the following extensions:
@@ -9071,12 +9072,12 @@ stub out functions that return unboxed types.
Printing levity-polymorphic types
---------------------------------
-.. ghc-flag:: -Wprint-explicit-runtime-rep
+.. ghc-flag:: -fprint-explicit-runtime-rep
:shortdesc: Print ``RuntimeRep`` variables in types which are
runtime-representation polymorphic.
:type: dynamic
:reverse: -fno-print-explicit-runtime-reps
- :category:
+ :category: verbosity
Print ``RuntimeRep`` parameters as they appear; otherwise, they are
defaulted to ``'LiftedRep``.
@@ -15158,3 +15159,4 @@ compilation with ``-prof``. On the other hand, as the ``CallStack`` is
built up explicitly via the ``HasCallStack`` constraints, it will
generally not contain as much information as the simulated call-stacks
maintained by the RTS.
+
diff --git a/docs/users_guide/phases.rst b/docs/users_guide/phases.rst
index d14a7fa5f1..d3189a5866 100644
--- a/docs/users_guide/phases.rst
+++ b/docs/users_guide/phases.rst
@@ -1145,5 +1145,5 @@ for example).
executables to ensure that only one ``libHSrts`` is present if
loaded into the address space of another Haskell process.
- Also, you may need to use the :ghc-flags:`-rdynamic` flag to ensure that
+ Also, you may need to use the :ghc-flag:`-rdynamic` flag to ensure that
that symbols are not dropped from your PIE objects.
diff --git a/docs/users_guide/safe_haskell.rst b/docs/users_guide/safe_haskell.rst
index 6b32826235..36dcd403ad 100644
--- a/docs/users_guide/safe_haskell.rst
+++ b/docs/users_guide/safe_haskell.rst
@@ -583,7 +583,7 @@ trust property of packages:
:shortdesc: Expose package ⟨pkg⟩ and set it to be trusted. See
:ref:`safe-haskell`.
:type: dynamic/ ``:set``
- :category:
+ :category: packages
Exposes package ⟨pkg⟩ if it was hidden and considers it a
trusted package regardless of the package database.
@@ -592,7 +592,7 @@ trust property of packages:
:shortdesc: Expose package ⟨pkg⟩ and set it to be distrusted. See
:ref:`safe-haskell`.
:type: dynamic/ ``:set``
- :category:
+ :category: packages
Exposes package ⟨pkg⟩ if it was hidden and considers it
an untrusted package regardless of the package database.
@@ -600,7 +600,7 @@ trust property of packages:
.. ghc-flag:: -distrust-all-packages
:shortdesc: Distrust all packages by default. See :ref:`safe-haskell`.
:type: dynamic/ ``:set``
- :category:
+ :category: packages
Considers all packages distrusted unless they are
explicitly set to be trusted by subsequent command-line options.
@@ -722,7 +722,7 @@ And one general flag:
:shortdesc: Enable :ref:`Safe Haskell <safe-haskell>` trusted package
requirement for trustworthy modules.
:type: dynamic
- :category:
+ :category: packages
When enabled, turn on an extra check for a trustworthy module ``M``,
requiring the package that ``M`` resides in be considered trusted, for ``M``
@@ -735,7 +735,7 @@ And three warning flags:
See :ref:`safe-haskell`
:type: dynamic
:reverse: -Wno-unsafe
- :category:
+ :category: warnings
Issue a warning if the module being compiled is regarded to be
unsafe. Should be used to check the safety type of modules when
@@ -745,7 +745,7 @@ And three warning flags:
:shortdesc: warn if the module being compiled is regarded to be safe.
:type: dynamic
:reverse: -Wno-safe
- :category:
+ :category: warnings
Issue a warning if the module being compiled is regarded to be safe.
Should be used to check the safety type of modules when using safe
@@ -757,7 +757,7 @@ And three warning flags:
:ghc-flag:`-XSafe`, a more informative bound.
:type: dynamic
:reverse: -Wno-safe
- :category:
+ :category: warnings
Issue a warning if the module being compiled is marked as
-XTrustworthy but it could instead be marked as