Small addition to the explanation of CmiAlloc
[charm.git] / doc / converse / cmi.tex
index 2e28c1ba623a5ab9e24e25d84d8ddc72d87d89c4..9baf576c4f4e1541533e7573725c7dce7edc5418 100644 (file)
@@ -118,7 +118,9 @@ The following functions are provided to help build message buffers:
 \desc{Allocates memory of size \uw{size} in heap and returns pointer to 
 the usable space.  There are some message-sending functions that
 accept only message buffers that were allocated with \kw{CmiAlloc}.  Thus,
-this is the preferred way to allocate message buffers.}
+this is the preferred way to allocate message buffers. The returned pointer
+point to the message header, the user data will follow it. See
+\kw{CmiMsgHeaderSizeBytes} for this.}
 
 \function{void CmiFree(void *ptr)}
 \index{CmiFree}