1
0
mirror of https://github.com/golang/go synced 2024-11-25 08:57:58 -07:00

runtime: correct Note documentation

Reflect the fact that notesleep() can be called
by exactly one thread.

R=golang-dev, rsc
CC=golang-dev
https://golang.org/cl/4816064
This commit is contained in:
Dmitriy Vyukov 2011-08-03 15:51:55 -04:00 committed by Russ Cox
parent b32e210586
commit a496c9eaa6

View File

@ -521,10 +521,13 @@ void runtime·destroylock(Lock*);
* sleep and wakeup on one-time events. * sleep and wakeup on one-time events.
* before any calls to notesleep or notewakeup, * before any calls to notesleep or notewakeup,
* must call noteclear to initialize the Note. * must call noteclear to initialize the Note.
* then, any number of threads can call notesleep * then, exactly one thread can call notesleep
* and exactly one thread can call notewakeup (once). * and exactly one thread can call notewakeup (once).
* once notewakeup has been called, all the notesleeps * once notewakeup has been called, the notesleep
* will return. future notesleeps will return immediately. * will return. future notesleep will return immediately.
* subsequent noteclear must be called only after
* previous notesleep has returned, e.g. it's disallowed
* to call noteclear straight after notewakeup.
*/ */
void runtime·noteclear(Note*); void runtime·noteclear(Note*);
void runtime·notesleep(Note*); void runtime·notesleep(Note*);