[commit: ghc] ghc-8.2: users-guide: Fix various wibbles (eeb2aa4)

[git at git.haskell.org]

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

On branch  : ghc-8.2
Link       : http://ghc.haskell.org/trac/ghc/changeset/eeb2aa4e1f31306fc4b2ef65e970d11c15ecffe6/ghc

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

commit eeb2aa4e1f31306fc4b2ef65e970d11c15ecffe6
Author: Ben Gamari <ben at smart-cactus.org>
Date:   Sun Jul 23 12:59:49 2017 -0400

    users-guide: Fix various wibbles
    
    (cherry picked from commit c9451959d8796ee5458cd0666dd2bc2114ac10d7)


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

eeb2aa4e1f31306fc4b2ef65e970d11c15ecffe6
 docs/users_guide/profiling.rst            | 19 +++++++++++--------
 docs/users_guide/runtime_control.rst      |  4 ++--
 docs/users_guide/separate_compilation.rst |  6 +++---
 3 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/docs/users_guide/profiling.rst b/docs/users_guide/profiling.rst
index 0a4ba09..e3796ed 100644
--- a/docs/users_guide/profiling.rst
+++ b/docs/users_guide/profiling.rst
@@ -429,6 +429,8 @@ enclosed between ``+RTS ... -RTS`` as usual):
 
 .. rts-flag:: -V ⟨secs⟩
 
+    :default: 0.02
+
     Sets the interval that the RTS clock ticks at, which is also the sampling
     interval of the time and allocation profile. The default is 0.02 seconds.
     The runtime uses a single timer signal to count ticks; this timer signal is
@@ -929,14 +931,15 @@ reasons for this:
 
 -  Garbage collection requires more memory than the actual residency.  The
    factor depends on the kind of garbage collection algorithm in use: a major GC
-   in the standard generation copying collector will usually require 3L bytes of
-   memory, where L is the amount of live data. This is because by default (see
-   the RTS :rts-flag:`-F ⟨factor⟩` option) we allow the old generation to grow
-   to twice its size (2L) before collecting it, and we require additionally L
-   bytes to copy the live data into. When using compacting collection (see the
-   :rts-flag:`-c` option), this is reduced to 2L, and can further be reduced by
-   tweaking the :rts-flag:`-F ⟨factor⟩` option. Also add the size of the
-   allocation area (see :rts-flag:`-A ⟨size⟩`).
+   in the standard generation copying collector will usually require :math:`3L`
+   bytes of memory, where :math:`L` is the amount of live data. This is because
+   by default (see the RTS :rts-flag:`-F ⟨factor⟩` option) we allow the old
+   generation to grow to twice its size (:math:`2L`) before collecting it, and
+   we require additionally :math:`L` bytes to copy the live data into. When
+   using compacting collection (see the :rts-flag:`-c` option), this is reduced
+   to :math:`2L`, and can further be reduced by tweaking the :rts-flag:`-F
+   ⟨factor⟩` option. Also add the size of the allocation area (see :rts-flag:`-A
+   ⟨size⟩`).
 
 -  The stack isn't counted in the heap profile by default. See the
    RTS :rts-flag:`-xt` option.
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 5286784..682ced8 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -253,7 +253,7 @@ Miscellaneous RTS options
     This option relates to allocation limits; for more about this see
     :base-ref:`enableAllocationLimit <GHC-Conc.html#v%3AenableAllocationLimit>`.
     When a thread hits its allocation limit, the RTS throws an exception
-    to the thread, and the thread gets an additional quota of allo
+    to the thread, and the thread gets an additional quota of allocation
     before the exception is raised again, the idea being so that the
     thread can execute its exception handlers. The ``-xq`` controls the
     size of this additional quota.
@@ -339,7 +339,7 @@ performance.
     .. index::
        single: allocation area, chunk size
 
-    [Example: ``-n4m``\ ] When set to a non-zero value, this
+    [Example: ``-n4m`` ] When set to a non-zero value, this
     option divides the allocation area (``-A`` value) into chunks of the
     specified size. During execution, when a processor exhausts its
     current chunk, it is given another chunk from the pool until the
diff --git a/docs/users_guide/separate_compilation.rst b/docs/users_guide/separate_compilation.rst
index 04ef591..06af6f0 100644
--- a/docs/users_guide/separate_compilation.rst
+++ b/docs/users_guide/separate_compilation.rst
@@ -1190,8 +1190,8 @@ generation are:
 .. ghc-flag:: -dep-suffix ⟨suffix⟩
 
     Make dependencies that declare that files with suffix
-    ``.<suf><osuf>`` depend on interface files with suffix
-    ``.<suf>hi``, or (for ``{-# SOURCE #-}`` imports) on ``.hi-boot``.
+    ``.⟨suf⟩⟨osuf⟩`` depend on interface files with suffix
+    ``.⟨suf⟩hi``, or (for ``{-# SOURCE #-}`` imports) on ``.hi-boot``.
     Multiple ``-dep-suffix`` flags are permitted. For example,
     ``-dep-suffix a_ -dep-suffix b_`` will make dependencies for ``.hs``
     on ``.hi``, ``.a_hs`` on ``.a_hi``, and ``.b_hs`` on ``.b_hi``.
@@ -1200,7 +1200,7 @@ generation are:
 
 .. ghc-flag:: --exclude-module=⟨file⟩
 
-    Regard ``<file>`` as "stable"; i.e., exclude it from having
+    Regard ``⟨file⟩`` as "stable"; i.e., exclude it from having
     dependencies on it.
 
 .. ghc-flag:: -include-pkg-deps