[commit: ghc] master: users-guide: Fix a variety of warnings (476307c)

[git at git.haskell.org]

Repository : ssh://git@git.haskell.org/ghc

On branch  : master
Link       : http://ghc.haskell.org/trac/ghc/changeset/476307cee7ff142b0eff91d45fddf17775417814/ghc

>---------------------------------------------------------------

commit 476307cee7ff142b0eff91d45fddf17775417814
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Mon May 8 17:35:05 2017 -0400

    users-guide: Fix a variety of warnings
    
    Including #13665.


>---------------------------------------------------------------

476307cee7ff142b0eff91d45fddf17775417814
 docs/users_guide/8.2.1-notes.rst        | 3 ++-
 docs/users_guide/8.4.1-notes.rst        | 5 ++---
 docs/users_guide/eventlog-formats.rst   | 3 +++
 docs/users_guide/glasgow_exts.rst       | 2 +-
 docs/users_guide/using-optimisation.rst | 3 +--
 docs/users_guide/using-warnings.rst     | 2 ++
 6 files changed, 11 insertions(+), 7 deletions(-)

diff --git a/docs/users_guide/8.2.1-notes.rst b/docs/users_guide/8.2.1-notes.rst
index 57c22a3..ba17e35 100644
--- a/docs/users_guide/8.2.1-notes.rst
+++ b/docs/users_guide/8.2.1-notes.rst
@@ -418,7 +418,8 @@ filepath
 ghc
 ~~~
 
--
+-  Version number 8.2.1
+
 ghc-boot
 ~~~~~~~~
 
diff --git a/docs/users_guide/8.4.1-notes.rst b/docs/users_guide/8.4.1-notes.rst
index 71eaa40..62173d5 100644
--- a/docs/users_guide/8.4.1-notes.rst
+++ b/docs/users_guide/8.4.1-notes.rst
@@ -76,9 +76,8 @@ Now we generate ::
 
       _ == _ = error ...
 
-- Lots of other bugs. See `Trac
-   <https://ghc.haskell.org/trac/ghc/query?status=closed&milestone=8.4.1&col=id&col=summary&col=status&col=type&col=priority&col=milestone&col=component&order=priority>`_
-   for a complete list.
+- Lots of other bugs. See `Trac <https://ghc.haskell.org/trac/ghc/query?status=closed&milestone=8.4.1&col=id&col=summary&col=status&col=type&col=priority&col=milestone&col=component&order=priority>`_
+  for a complete list.
 
 Runtime system
 ~~~~~~~~~~~~~~
diff --git a/docs/users_guide/eventlog-formats.rst b/docs/users_guide/eventlog-formats.rst
index f7eb1ca..8b1427d 100644
--- a/docs/users_guide/eventlog-formats.rst
+++ b/docs/users_guide/eventlog-formats.rst
@@ -32,12 +32,14 @@ A single fixed-width event emitted during program start-up describing the sample
    * ``Word8``: Profile ID
    * ``Word64``: Sampling period in nanoseconds
    * ``Word32``: Sample break-down type. One of,
+
       * ``SAMPLE_TYPE_COST_CENTER`` (output from ``-hc``)
       * ``SAMPLE_TYPE_CLOSURE_DESCR`` (output from ``-hd``)
       * ``SAMPLE_TYPE_RETAINER`` (output from ``-hr``)
       * ``SAMPLE_TYPE_MODULE`` (output from ``-hm``)
       * ``SAMPLE_TYPE_TYPE_DESCR`` (output from ``-hy``)
       * ``SAMPLE_TYPE_BIOGRAPHY`` (output from ``-hb``)
+
    * ``String``: Module filter
    * ``String``: Closure description filter
    * ``String``: Type description filter
@@ -57,6 +59,7 @@ A variable-length packet produced once for each cost centre,
    * ``String``: module
    * ``String``: source location
    * ``Word8``: flags
+
      * bit 0: is the cost-centre a CAF?
 
 
diff --git a/docs/users_guide/glasgow_exts.rst b/docs/users_guide/glasgow_exts.rst
index 6e394e7..2b7b652 100644
--- a/docs/users_guide/glasgow_exts.rst
+++ b/docs/users_guide/glasgow_exts.rst
@@ -10545,7 +10545,7 @@ for constructing pretty-printed error messages, ::
         | ErrorMessage :<>: ErrorMessage     -- Put two chunks of error message next to each other
         | ErrorMessage :$$: ErrorMessage     -- Put two chunks of error message above each other
 
-in the ``GHC.TypeLits`` :base-ref:`module <GHC-TypeList.html>`.
+in the ``GHC.TypeLits`` :base-ref:`module <GHC-TypeLits.html>`.
 
 For instance, we might use this interface to provide a more useful error
 message for applications of ``show`` on unsaturated functions like this, ::
diff --git a/docs/users_guide/using-optimisation.rst b/docs/users_guide/using-optimisation.rst
index d52ed04..cfecc34 100644
--- a/docs/users_guide/using-optimisation.rst
+++ b/docs/users_guide/using-optimisation.rst
@@ -108,8 +108,7 @@ The easiest way to see what ``-O`` (etc.) “really mean” is to run with
 These flags turn on and off individual optimisations. Flags marked as
 on by default are enabled by ``-O``, and as such you shouldn't
 need to set any of them explicitly. A flag ``-fwombat`` can be negated
-by saying ``-fno-wombat``. See :ref:`options-f-compact` for a compact
-list.
+by saying ``-fno-wombat``.
 
 .. ghc-flag:: -fcase-merge
 
diff --git a/docs/users_guide/using-warnings.rst b/docs/users_guide/using-warnings.rst
index 21594ec..ed2b12b 100644
--- a/docs/users_guide/using-warnings.rst
+++ b/docs/users_guide/using-warnings.rst
@@ -104,6 +104,7 @@ to abort.
     warnings when doing batch compilation.
 
 .. ghc-flag:: -Werror=<wflag>
+    :noindex:
 
     :implies: ``-W<wflag>``
 
@@ -116,6 +117,7 @@ to abort.
     default, but can be useful to negate a :ghc-flag:`-Werror` flag.
 
 .. ghc-flag:: -Wwarn=<wflag>
+    :noindex:
 
     Causes a specific warning to be treated as normal warning, not fatal error.