From: lottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Date: Tue, 29 Dec 2009 09:03:10 +0000 (+0000)
Subject: doc: Clarify Msg documentation.
X-Git-Tag: 2.4.0~66
X-Git-Url: https://codewiz.org/gitweb?a=commitdiff_plain;h=dcee6b7043c0b895dc3489dd379a5264b5af32c1;p=bertos.git

doc: Clarify Msg documentation.

git-svn-id: https://src.develer.com/svnoss/bertos/trunk@3131 38d2e660-2303-0410-9eaa-f027e97ec537
---

diff --git a/bertos/kern/msg.h b/bertos/kern/msg.h
index 32232c56..f00f6060 100644
--- a/bertos/kern/msg.h
+++ b/bertos/kern/msg.h
@@ -67,6 +67,11 @@
  * receiver wakes up, it usually invokes msg_get() to pick
  * the next message from the port.
  *
+ * \note
+ * When you put a message into a port, such message becomes
+ * unavailable until you retrieve it using msg_get(), eg.
+ * you must not delete it or put it into another port.
+ *
  * Message ports can hold any number of pending messages,
  * and receivers usually process them in FIFO order.
  * Other scheduling policies are possible, but not implemented