[Xenomai-core] [PATCH] -ETIMEDOUT return value not described in rt_cond_wait API documentation?

[Xenomai-core] [PATCH] -ETIMEDOUT return value not described in rt_cond_wait API documentation?

[Klaas Gadeyne]

[-- Attachment #1: Type: TEXT/PLAIN, Size: 498 bytes --]

Hi,

it seems -ETIMEDOUT is not mentioned as a possible return value of
rt_cond_wait() in the API docs [1], although it *is* returned in case
of the timeout having expired [2]?

Attached patch tries to solve this against the 2.4 branch.

regards,

Klaas

ps.  This seems to apply to 2.3, 2.4 and trunk.

[1]
<http://www.xenomai.org/documentation/trunk/html/api/group__cond.html#g3aa51073817be2ffb2a880a7393502e8>
[2] 
<http://www.rts.uni-hannover.de/xenomai/lxr/source/ksrc/skins/native/cond.c#493>

[-- Attachment #2: Type: TEXT/x-diff, Size: 523 bytes --]

Index: cond.c
===================================================================
--- cond.c	(revision 3717)
+++ cond.c	(working copy)
@@ -416,6 +416,9 @@
  * descriptor, including if the deletion occurred while the caller was
  * sleeping on the variable.
  *
+ * - -ETIMEDOUT is returned if @a timeout expired before the condition
+ * variable has been signaled.
+ *
  * - -EINTR is returned if rt_task_unblock() has been called for the
  * waiting task before the condition variable has been signaled.
  *

Re: [Xenomai-core] [PATCH] -ETIMEDOUT return value not described in rt_cond_wait API documentation?

[Philippe Gerum]

Klaas Gadeyne wrote:
> Hi,
> 
> it seems -ETIMEDOUT is not mentioned as a possible return value of
> rt_cond_wait() in the API docs [1], although it *is* returned in case
> of the timeout having expired [2]?
>

Indeed. Applied, thanks.

> Attached patch tries to solve this against the 2.4 branch.
> 
> regards,
> 
> Klaas
> 
> ps.  This seems to apply to 2.3, 2.4 and trunk.
> 
> [1]
> <http://www.xenomai.org/documentation/trunk/html/api/group__cond.html#g3aa51073817be2ffb2a880a7393502e8>
> 
> [2]
> <http://www.rts.uni-hannover.de/xenomai/lxr/source/ksrc/skins/native/cond.c#493>
> 
> 
> ------------------------------------------------------------------------
> 
> _______________________________________________
> Xenomai-core mailing list
> Xenomai-core@domain.hid
> https://mail.gna.org/listinfo/xenomai-core


-- 
Philippe.