From: Dmitriy Vyukov <dvyukov@google.com>
Date: Wed, 3 Aug 2011 19:51:55 +0000 (-0400)
Subject: runtime: correct Note documentation
X-Git-Tag: weekly.2011-08-10~42
X-Git-Url: http://www.git.cypherpunks.su/?a=commitdiff_plain;h=a496c9eaa62a5456dbb53502c186193c0528440f;p=gostls13.git

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
---

diff --git a/src/pkg/runtime/runtime.h b/src/pkg/runtime/runtime.h
index 44511da830..434c82b95d 100644
--- a/src/pkg/runtime/runtime.h
+++ b/src/pkg/runtime/runtime.h
@@ -521,10 +521,13 @@ void	runtime·destroylock(Lock*);
  * sleep and wakeup on one-time events.
  * before any calls to notesleep or notewakeup,
  * 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).
- * once notewakeup has been called, all the notesleeps
- * will return.  future notesleeps will return immediately.
+ * once notewakeup has been called, the notesleep
+ * 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·notesleep(Note*);