diff options
| author | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-28 08:25:11 +0200 |
|---|---|---|
| committer | Sebastian Huber <sebastian.huber@embedded-brains.de> | 2020-07-28 08:25:33 +0200 |
| commit | 24859653003395e30c5a093a45a6855974563f4f (patch) | |
| tree | 4e6079db660f417d936bd62bb40abff67498d968 /spec/if/rtems/event | |
| parent | 3e303edd752e16ae8eaf0c6204b473503205dde0 (diff) | |
spec: Clarify event receive description
Diffstat (limited to 'spec/if/rtems/event')
| -rw-r--r-- | spec/if/rtems/event/receive.yml | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/spec/if/rtems/event/receive.yml b/spec/if/rtems/event/receive.yml index 84000428..ce1f7f98 100644 --- a/spec/if/rtems/event/receive.yml +++ b/spec/if/rtems/event/receive.yml @@ -17,18 +17,18 @@ definition: description: | This directive can be used to - * get the pending events of the task, or + * get the pending events of the calling task, or * receive events. - To *get the pending event set* use the constant ${pending-events:/name} for - the ``${.:/params[0]/name}`` parameter. The pending events are returned to - the calling task but the event set of the task is left unaltered. The + To *get the pending events* use the constant ${pending-events:/name} for the + ``${.:/params[0]/name}`` parameter. The pending events are returned to the + calling task but the event set of the task is left unaltered. The ``${.:/params[1]/name}`` and ``${.:params[2]/name}`` parameters are ignored in this case. The directive returns immediately and does not block. To *receive events* you have to define an input event condition and some - options. The option set specified in ``${.:/params[2]/name}`` defines + options. The option set specified in ``${.:/params[1]/name}`` defines * if the task will wait or poll for the events, and |