Module: xenomai-forge
Branch: next
Commit: 5438340e68f35e3b314acd3d63382d8bd38527c8
URL:
http://git.xenomai.org/?p=xenomai-forge.git;a=commit;h=5438340e68f35e3b314acd3d63382d8bd38527c8
Author: Philippe Gerum <r...@xenomai.org>
Date: Thu Jul 3 12:16:58 2014 +0200
cobalt/rtdm: update documentation
---
kernel/cobalt/rtdm/drvlib.c | 8 +++++---
1 file changed, 5 insertions(+), 3 deletions(-)
diff --git a/kernel/cobalt/rtdm/drvlib.c b/kernel/cobalt/rtdm/drvlib.c
index cc1c6f0..02dfa35 100644
--- a/kernel/cobalt/rtdm/drvlib.c
+++ b/kernel/cobalt/rtdm/drvlib.c
@@ -96,7 +96,8 @@ nanosecs_abs_t rtdm_clock_read_monotonic(void);
* @param[in] priority Priority of the task, see also
* @ref rtdmtaskprio "Task Priority Range"
* @param[in] period Period in nanoseconds of a cyclic task, 0 for non-cyclic
- * mode
+ * mode. Waiting for the first and subsequent periodic events is
+ * done using rtdm_task_wait_period().
*
* @return 0 on success, otherwise negative error code
*
@@ -417,8 +418,9 @@ EXPORT_SYMBOL_GPL(rtdm_timer_destroy);
*
* @return 0 on success, otherwise:
*
- * - -ETIMEDOUT is returned if @c expiry describes an absolute date in the
- * past.
+ * - -ETIMEDOUT is returned if @c expiry describes an absolute date in
+ * the past. In such an event, the timer is nevertheless armed for the
+ * next shot in the timeline if @a interval is non-zero.
*
* @coretags{unrestricted}
*/
_______________________________________________
Xenomai-git mailing list
Xenomai-git@xenomai.org
http://www.xenomai.org/mailman/listinfo/xenomai-git
