diff options
| author | Ben Gamari <ben@well-typed.com> | 2019-02-05 10:43:56 -0500 |
|---|---|---|
| committer | Ben Gamari <ben@smart-cactus.org> | 2019-10-18 15:26:53 -0400 |
| commit | 113950379c2d945397d30f89f4fda0080eac112b (patch) | |
| tree | 42f361b5fa507c8bed035725ef72c17a2c2351cf /rts | |
| parent | 61d2ed42f85469fd3878029944ea4b6e50687098 (diff) | |
| download | haskell-113950379c2d945397d30f89f4fda0080eac112b.tar.gz | |
rts/Capability: A few documentation comments
Diffstat (limited to 'rts')
| -rw-r--r-- | rts/Capability.c | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/rts/Capability.c b/rts/Capability.c index 33a94398cd..8b552e0b09 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) |