doc: Clarify Msg documentation.

[bertos.git] / bertos / kern / msg.h

diff --git a/bertos/kern/msg.h b/bertos/kern/msg.h
index 32232c56e018d3e2d487bddfb318fc840a50a96c..f00f6060294e224edd97c65c2abea38a23fc6ce6 100644 (file)
--- 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