doc: Clarify Msg documentation.
authorlottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Tue, 29 Dec 2009 09:03:10 +0000 (09:03 +0000)
committerlottaviano <lottaviano@38d2e660-2303-0410-9eaa-f027e97ec537>
Tue, 29 Dec 2009 09:03:10 +0000 (09:03 +0000)
git-svn-id: https://src.develer.com/svnoss/bertos/trunk@3131 38d2e660-2303-0410-9eaa-f027e97ec537

bertos/kern/msg.h

index 32232c56e018d3e2d487bddfb318fc840a50a96c..f00f6060294e224edd97c65c2abea38a23fc6ce6 100644 (file)
  * 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