[RTEMS Project] #1766: Lack of information on the configuration of message buffers in the workspace

[RTEMS trac]

#1766: Lack of information on the configuration of message buffers in the
workspace
----------------------+----------------------------
 Reporter:  fabricio  |       Owner:  joel.sherrill
     Type:  defect    |      Status:  closed
 Priority:  normal    |   Milestone:  4.11
Component:  doc       |     Version:  4.10
 Severity:  normal    |  Resolution:  fixed
 Keywords:            |
----------------------+----------------------------
Description changed by chrisj:

Old description:

> The information on the use of the CONFIGURE_MESSAGE_BUFFER_MEMORY macro
> seems not to be clear enough in the documentation.
>
> A suggestion would be to make a little change in the RTEMS User's Manual,
> item 10.4.1, 'Description'.
>
> Something like: "... Memory is allocated from the RTEMS Workspace for the
> specified count of messages, each of max_message_size bytes in length
> (see the CONFIGURE_MESSAGE_BUFFER_MEMORY configuration parameter on item
> 23.2.2)."
>
> Reference: http://www.rtems.org/ml/rtems-users/2011/march/msg00110.html.

New description:

 The information on the use of the CONFIGURE_MESSAGE_BUFFER_MEMORY macro
 seems not to be clear enough in the documentation.

 A suggestion would be to make a little change in the RTEMS User's Manual,
 item 10.4.1, 'Description'.

 Something like: "... Memory is allocated from the RTEMS Workspace for the
 specified count of messages, each of max_message_size bytes in length (see
 the CONFIGURE_MESSAGE_BUFFER_MEMORY configuration parameter on item
 23.2.2)."

 Reference: http://lists.rtems.org/pipermail/users/2011-March/023290.html.

--

--
Ticket URL: <http://devel.rtems.org/ticket/1766#comment:2>
RTEMS Project <http://www.rtems.org/>
RTEMS Project