[Git][ghc/ghc][master] Add links to the continuations haddocks in the docs for each primop

[Marge Bot (@marge-bot)]

Marge Bot pushed to branch master at Glasgow Haskell Compiler / GHC


Commits:
df35d994 by Alexis King at 2022-09-16T14:01:11-04:00
Add links to the continuations haddocks in the docs for each primop

fixes #22176

- - - - -


2 changed files:

- compiler/GHC/Builtin/primops.txt.pp
- docs/users_guide/9.6.1-notes.rst


Changes:

=====================================
compiler/GHC/Builtin/primops.txt.pp
=====================================
@@ -2634,7 +2634,9 @@ primop  MaskStatus "getMaskingState#" GenPrimOp
 
 ------------------------------------------------------------------------
 section "Continuations"
-  { These operations provide access to first-class delimited continuations,
+  { #continuations#
+
+    These operations provide access to first-class delimited continuations,
     which allow a computation to access and manipulate portions of its
     /current continuation/. Operationally, they are implemented by direct
     manipulation of the RTS call stack, which may provide significant
@@ -2791,9 +2793,11 @@ section "Continuations"
 ------------------------------------------------------------------------
 
 primtype PromptTag# a
+   { See "GHC.Prim#continuations". }
 
 primop  NewPromptTagOp "newPromptTag#" GenPrimOp
         State# RealWorld -> (# State# RealWorld, PromptTag# a #)
+   { See "GHC.Prim#continuations". }
    with
    out_of_line = True
    has_side_effects = True
@@ -2802,6 +2806,7 @@ primop  PromptOp "prompt#" GenPrimOp
         PromptTag# a
      -> (State# RealWorld -> (# State# RealWorld, a #))
      -> State# RealWorld -> (# State# RealWorld, a #)
+   { See "GHC.Prim#continuations". }
    with
    strictness = { \ _arity -> mkClosedDmdSig [topDmd, strictOnceApply1Dmd, topDmd] topDiv }
    out_of_line = True
@@ -2813,6 +2818,7 @@ primop  Control0Op "control0#" GenPrimOp
           -> State# RealWorld -> (# State# RealWorld, a #))
          -> State# RealWorld -> (# State# RealWorld, a #))
      -> State# RealWorld -> (# State# RealWorld, p #)
+   { See "GHC.Prim#continuations". }
    with
    strictness = { \ _arity -> mkClosedDmdSig [topDmd, lazyApply2Dmd, topDmd] topDiv }
    out_of_line = True


=====================================
docs/users_guide/9.6.1-notes.rst
=====================================
@@ -91,7 +91,7 @@ Runtime system
   no safe API to access this functionality is provided anywhere in ``base``.
   Instead, the ``prompt#`` and ``control0#`` primops are intended to be consumed
   by library authors directly, who may wrap them a safe API that maintains the
-  necessary invariants. See the documentation in ``GHC.Exts`` for more details.
+  necessary invariants. See the documentation in ``GHC.Prim`` for more details.
 
 ``base`` library
 ~~~~~~~~~~~~~~~~



View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/df35d99465d1037b31cbd05aa3380fce6031af73

-- 
View it on GitLab: https://gitlab.haskell.org/ghc/ghc/-/commit/df35d99465d1037b31cbd05aa3380fce6031af73
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/20220916/8581100a/attachment-0001.html>