Commit 11395037 authored by Ben Gamari's avatar Ben Gamari 🐢 Committed by Ben Gamari

rts/Capability: A few documentation comments

parent 61d2ed42
......@@ -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)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment