[Git][ghc/ghc][wip/T24127] 4 commits: users guide: Mention language extensions in equality constraints discussion

[Ben Gamari (@bgamari)]

Ben Gamari pushed to branch wip/T24127 at Glasgow Haskell Compiler / GHC


Commits:
01faa387 by Ben Gamari at 2024-11-15T11:09:11-05:00
users guide: Mention language extensions in equality constraints discussion

As suggested in #24127, mention the language extensions necessary for
usage of equality constriants in their documentation.

Closes #24127.

- - - - -
b0ccda11 by Ben Gamari at 2024-11-15T11:12:08-05:00
users-guide/9.14.1-notes: Fix list syntax

- - - - -
ca3cc13b by Ben Gamari at 2024-11-15T11:12:29-05:00
users-guide/debug-info: Fix duplicate flag descriptions

- - - - -
4c67e3c3 by Ben Gamari at 2024-11-15T11:13:51-05:00
users-guide: Fix reference to 9.14.1 release notes

- - - - -


4 changed files:

- docs/users_guide/9.14.1-notes.rst
- docs/users_guide/debug-info.rst
- docs/users_guide/exts/equality_constraints.rst
- docs/users_guide/release-notes.rst


Changes:

=====================================
docs/users_guide/9.14.1-notes.rst
=====================================
@@ -51,7 +51,7 @@ Cmm
 ~~~~~~~~~~~~~~~~~~~~
 
 * The functions `getClosureInfoTbl_maybe`, `getClosureInfoTbl`,
- `getClosurePtrArgs` and `getClosurePtrArgs_maybe` have been added to allow
+  `getClosurePtrArgs` and `getClosurePtrArgs_maybe` have been added to allow
   reading of the relevant Closure attributes without reliance on incomplete
   selectors.
 


=====================================
docs/users_guide/debug-info.rst
=====================================
@@ -395,18 +395,6 @@ to a source location. This lookup table is generated by using the ``-finfo-table
     :implies: :ghc-flag:`-finfo-table-map-with-stack`
     :implies: :ghc-flag:`-finfo-table-map-with-fallback`
 
-.. ghc-flag:: -finfo-table-map-with-stack
-    :shortdesc: Include info tables for ``STACK`` closures in the info table
-                map.
-    :type: dynamic
-    :reverse: -fno-info-table-map-with-stack
-    :category: debugging
-
-    :since: 9.10
-
-    Include info tables for ``STACK`` closures in the info table map. Note that
-    this flag is implied by :ghc-flag:`-finfo-table-map`.
-
 .. ghc-flag:: -fno-info-table-map-with-stack
     :shortdesc: Omit info tables for ``STACK`` closures from the info table
                 map.
@@ -423,6 +411,9 @@ to a source location. This lookup table is generated by using the ``-finfo-table
     ``STACK`` info tables from the info table map and decrease the size of
     executables with info table profiling information.
 
+    Note that :ghc-flag:`-finfo-table-map-with-stack` is implied by
+    :ghc-flag:`-finfo-table-map`.
+
 .. ghc-flag:: -finfo-table-map-with-fallback
     :shortdesc: Include info tables with no source location information in the
                 info table map.


=====================================
docs/users_guide/exts/equality_constraints.rst
=====================================
@@ -6,11 +6,11 @@ Equality constraints and Coercible constraint
 Equality constraints
 --------------------
 
-A type context can include equality constraints of the form ``t1 ~ t2``,
-which denote that the types ``t1`` and ``t2`` need to be the same. In
-the presence of type families, whether two types are equal cannot
-generally be decided locally. Hence, the contexts of function signatures
-may include equality constraints, as in the following example: ::
+When :extension:`TypeOperators` are enabled, a type context can include equality
+constraints of the form ``t1 ~ t2``, which denote that the types ``t1`` and
+``t2`` need to be the same. In the presence of type families, whether two types
+are equal cannot generally be decided locally. Hence, the contexts of function
+signatures may include equality constraints, as in the following example: ::
 
     sumCollects :: (Collects c1, Collects c2, Elem c1 ~ Elem c2) => c1 -> c2 -> c2
 


=====================================
docs/users_guide/release-notes.rst
=====================================
@@ -4,4 +4,4 @@ Release notes
 .. toctree::
    :maxdepth: 1
 
-   9.12.1-notes
+   9.14.1-notes



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/9b3327927cb12ca5b04f1aa4b2e54ab839bdae62...4c67e3c324a05f85ff74776a4028bf79878cb42a

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/compare/9b3327927cb12ca5b04f1aa4b2e54ab839bdae62...4c67e3c324a05f85ff74776a4028bf79878cb42a
You're receiving this email because of your account on gitlab.haskell.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.haskell.org/pipermail/ghc-commits/attachments/20241115/be7bed2b/attachment-0001.html>