[commit: ghc] wip/nonmoving-gc: rts/Capability: A few documentation comments (4a94369)

[git at git.haskell.org]

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

On branch  : wip/nonmoving-gc
Link       : http://ghc.haskell.org/trac/ghc/changeset/4a94369e600014cf0c93d0710b524686449aba4c/ghc

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

commit 4a94369e600014cf0c93d0710b524686449aba4c
Author: Ben Gamari <ben at well-typed.com>
Date:   Tue Feb 5 10:43:56 2019 -0500

    rts/Capability: A few documentation comments


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

4a94369e600014cf0c93d0710b524686449aba4c
 rts/Capability.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/rts/Capability.c b/rts/Capability.c
index bda3b0e..a1f994d 100644
--- a/rts/Capability.c
+++ b/rts/Capability.c
@@ -748,6 +748,8 @@ static Capability * waitForReturnCapability (Task *task)
  * result of the external call back to the Haskell thread that
  * made it.
  *
+ * pCap is strictly an output.
+ *
  * ------------------------------------------------------------------------- */
 
 void waitForCapability (Capability **pCap, Task *task)
@@ -840,6 +842,9 @@ void waitForCapability (Capability **pCap, Task *task)
  *      SYNC_GC_PAR), either to do a sequential GC, forkProcess, or
  *      setNumCapabilities.  We should give up the Capability temporarily.
  *
+ * When yieldCapability returns *pCap will have been updated to the new
+ * capability held by the caller.
+ *
  * ------------------------------------------------------------------------- */
 
 #if defined (THREADED_RTS)