From: Andy Green <andy@warmcat.com>
Date: Tue, 14 Mar 2017 23:28:51 +0000 (+0800)
Subject: docs: lws_callback_all_protocol: fix cut-n-paste error and explain it is probably... 
X-Git-Tag: upstream/2.3.0~172
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=ed27be42c97cb4d68bfe290e982e460687692dfc;p=platform%2Fupstream%2Flibwebsockets.git

docs: lws_callback_all_protocol: fix cut-n-paste error and explain it is probably not what you want
---

diff --git a/lib/libwebsockets.h b/lib/libwebsockets.h
index 1f7cf6fd..751206d5 100644
--- a/lib/libwebsockets.h
+++ b/lib/libwebsockets.h
@@ -3605,8 +3605,12 @@ lws_callback_on_writable_all_protocol_vhost(const struct lws_vhost *vhost,
  * \param reason:	Callback reason index
  *
  * - Which:  connections using this protocol on ALL VHOSTS
- * - When:   when the individual connection becomes writeable
+ * - When:   before returning
  * - What:   reason
+ *
+ * This isn't normally what you want... normally any update of connection-
+ * specific information can wait until a network-related callback like rx,
+ * writable, or close.
  */
 LWS_VISIBLE LWS_EXTERN int
 lws_callback_all_protocol(struct lws_context *context,