[rtems-central commit] spec: Clarify event receive description
Sebastian Huber
sebh at rtems.org
Tue Jul 28 06:25:49 UTC 2020
Module: rtems-central
Branch: master
Commit: 24859653003395e30c5a093a45a6855974563f4f
Changeset: http://git.rtems.org/rtems-central/commit/?id=24859653003395e30c5a093a45a6855974563f4f
Author: Sebastian Huber <sebastian.huber at embedded-brains.de>
Date: Tue Jul 28 08:25:11 2020 +0200
spec: Clarify event receive description
---
spec/if/rtems/event/receive.yml | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/spec/if/rtems/event/receive.yml b/spec/if/rtems/event/receive.yml
index 8400042..ce1f7f9 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
More information about the vc
mailing list