[rtems commit] rtems: Transient event documentation

Sebastian Huber sebh at rtems.org
Mon Nov 5 09:36:30 UTC 2012


Module:    rtems
Branch:    master
Commit:    d2cf254485324993ea50987748d8838cf1e240a4
Changeset: http://git.rtems.org/rtems/commit/?id=d2cf254485324993ea50987748d8838cf1e240a4

Author:    Sebastian Huber <sebastian.huber at embedded-brains.de>
Date:      Mon Nov  5 10:37:18 2012 +0100

rtems: Transient event documentation

---

 cpukit/rtems/include/rtems/rtems/event.h |   12 ++++++------
 1 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index 58abc71..9b43f79 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/cpukit/rtems/include/rtems/rtems/event.h
@@ -281,27 +281,27 @@ rtems_status_code rtems_event_system_receive(
  *   M [label="Main Task"], IDLE [label="Idle Task"], S [label="Server"], TIME [label="System Tick Handler"];
  *   |||;
  *   --- [label="sequence with request completion"];
- *   M box M [label="prepare request\nissue request\ncall rtems_event_transient_receive()"];
+ *   M box M [label="prepare request\nissue request\nrtems_event_transient_receive()"];
  *   M=>>IDLE [label="blocking operation"];
  *   IDLE=>>S [label="request completion"];
- *   S box S [label="call rtems_event_transient_send()"];
+ *   S box S [label="rtems_event_transient_send()"];
  *   S=>>M [label="task is ready again"];
  *   M box M [label="finish request"];
  *   |||;
  *   --- [label="sequence with early request completion"];
  *   M box M [label="prepare request\nissue request"];
  *   M=>>S [label="request completion"];
- *   S box S [label="call rtems_event_transient_send()"];
+ *   S box S [label="rtems_event_transient_send()"];
  *   S=>>M [label="transient event is now pending"];
- *   M box M [label="call rtems_event_transient_receive()\nfinish request"];
+ *   M box M [label="rtems_event_transient_receive()\nfinish request"];
  *   |||;
  *   --- [label="sequence with timeout event"];
- *   M box M [label="prepare request\nissue request\ncall rtems_event_transient_receive()"];
+ *   M box M [label="prepare request\nissue request\nrtems_event_transient_receive()"];
  *   M=>>IDLE [label="blocking operation"];
  *   IDLE=>>TIME [label="timeout expired"];
  *   TIME box TIME [label="cancel blocking operation"];
  *   TIME=>>M [label="task is ready again"];
- *   M box M [label="cancel request\ncall rtems_event_transient_clear()"];
+ *   M box M [label="cancel request\nrtems_event_transient_clear()"];
  * @endmsc
  *
  * Suppose you have a task that wants to issue a certain request and then waits




More information about the vc mailing list