summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBen Gamari <ben@smart-cactus.org>2020-09-17 10:48:12 -0400
committerMarge Bot <ben+marge-bot@smart-cactus.org>2020-09-19 15:51:07 -0400
commit4df3aa956260e3d84232f43546e297cf425081dd (patch)
treec6aa0ea6edc4900bafb32aa74b60a502fad405c8 /docs
parent2ae0edbdfaf920d0c4da4edf721b947e11eb054c (diff)
downloadhaskell-4df3aa956260e3d84232f43546e297cf425081dd.tar.gz
users guide: Fix various documentation issues
Diffstat (limited to 'docs')
-rw-r--r--docs/users_guide/9.0.1-notes.rst7
-rw-r--r--docs/users_guide/exts/explicit_forall.rst4
-rw-r--r--docs/users_guide/exts/instances.rst12
-rw-r--r--docs/users_guide/release-notes.rst1
-rw-r--r--docs/users_guide/runtime_control.rst7
5 files changed, 20 insertions, 11 deletions
diff --git a/docs/users_guide/9.0.1-notes.rst b/docs/users_guide/9.0.1-notes.rst
index 45a796fb07..1b48f874f6 100644
--- a/docs/users_guide/9.0.1-notes.rst
+++ b/docs/users_guide/9.0.1-notes.rst
@@ -49,9 +49,10 @@ Highlights
- GHC now relies on a new "ghc-bignum" package to provide Integer/Natural
implementations. This package supports the following backends:
- - gmp: adapted from integer-gmp package that was used before
- - native: new Haskell implementation, faster than integer-simple which is
- not used anymore
+
+ - gmp: adapted from integer-gmp package that was used before
+ - native: new Haskell implementation, faster than integer-simple which is
+ not used anymore
- All backends now use the same representation for big numbers (the one that
was previously used only by integer-gmp). It led to several compiler
diff --git a/docs/users_guide/exts/explicit_forall.rst b/docs/users_guide/exts/explicit_forall.rst
index 040145444a..1eeb723a84 100644
--- a/docs/users_guide/exts/explicit_forall.rst
+++ b/docs/users_guide/exts/explicit_forall.rst
@@ -37,9 +37,9 @@ Notes:
instance forall a. Eq a => Eq [a] where ...
- Note that the use of ``forall``s in instance declarations is somewhat
+ Note that the use of ``forall``\s in instance declarations is somewhat
restricted in comparison to other types. For example, instance declarations
- are not allowed to contain nested ``forall``s. See
+ are not allowed to contain nested ``forall``\s. See
:ref:`formal-instance-syntax` for more information.
- If the :ghc-flag:`-Wunused-foralls` flag is enabled, a warning will be emitted
diff --git a/docs/users_guide/exts/instances.rst b/docs/users_guide/exts/instances.rst
index 14b2e39a27..ac1f59d933 100644
--- a/docs/users_guide/exts/instances.rst
+++ b/docs/users_guide/exts/instances.rst
@@ -141,22 +141,22 @@ Where:
- ``btype`` is a type that is not allowed to have an outermost
``forall``/``=>`` unless it is surrounded by parentheses. For example,
- ``forall a. a`` and ``Eq a => a`` are not legal ``btype``s, but
+ ``forall a. a`` and ``Eq a => a`` are not legal ``btype``\s, but
``(forall a. a)`` and ``(Eq a => a)`` are legal.
- ``ctype`` is a ``btype`` that has no restrictions on an outermost
- ``forall``/``=>``, so ``forall a. a`` and ``Eq a => a`` are legal ``ctype``s.
-- ``arg_type`` is a type that is not allowed to have ``forall``s or ``=>``s
+ ``forall``/``=>``, so ``forall a. a`` and ``Eq a => a`` are legal ``ctype``\s.
+- ``arg_type`` is a type that is not allowed to have ``forall``s or ``=>``\s
- ``prefix_cls_tycon`` is a class type constructor written prefix (e.g.,
``Show`` or ``(&&&)``), while ``infix_cls_tycon`` is a class type constructor
- written infix (e.g., ```Show``` or ``&&&``).
+ written infix (e.g., ``\`Show\``` or ``&&&``).
This is a simplified grammar that does not fully delve into all of the
implementation details of GHC's parser (such as the placement of Haddock
comments), but it is sufficient to attain an understanding of what is
syntactically allowed. Some further various observations about this grammar:
-- Instance declarations are not allowed to be declared with nested ``forall``s
- or ``=>``s. For example, this would be rejected: ::
+- Instance declarations are not allowed to be declared with nested ``forall``\s
+ or ``=>``\s. For example, this would be rejected: ::
instance forall a. forall b. C (Either a b) where ...
diff --git a/docs/users_guide/release-notes.rst b/docs/users_guide/release-notes.rst
index bb670e445a..92d4277a67 100644
--- a/docs/users_guide/release-notes.rst
+++ b/docs/users_guide/release-notes.rst
@@ -5,3 +5,4 @@ Release notes
:maxdepth: 1
9.0.1-notes
+ 9.2.1-notes
diff --git a/docs/users_guide/runtime_control.rst b/docs/users_guide/runtime_control.rst
index 4c5c437753..d19f3d07fc 100644
--- a/docs/users_guide/runtime_control.rst
+++ b/docs/users_guide/runtime_control.rst
@@ -183,6 +183,13 @@ Event log output
Furthermore GHC lets you specify the way event log data (see :rts-flag:`-l
⟨flags⟩`) is written through a custom :c:type:`EventLogWriter`:
+.. The size_t declaration below is simply to ensure that the build doesn't fail with an
+ undefined reference target warning as Sphinx doesn't know about size_t.
+
+.. c:type:: size_t
+
+ :hidden:
+
.. c:type:: EventLogWriter
A sink of event-log data.