Skip to contentSkip to conversation

rt_pipe_receive documentation

PATCH In review Sebastian Smolorz 2 participants 2 messages May 27, 2008

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rt_pipe_receive documentation

Hi,

rt_pipe_receive() doesn't return -EIDRM any more. The patches for trunk and v2.4.x correct the API documentation in this regard.

Signature · 1 line
Sebastian
ChangeLog +6 -0
Index: ChangeLog
===================================================================
@@ -1,3 +1,9 @@
+2008-05-27  Sebastian Smolorz  <[email protected]>
+
+	* ksrc/skins/native/pipe.c (rt_pipe_receive): Fix documentation
+	for the return values of the function. -EIDRM is no valid return
+	value any more.
+
 2008-05-25  Wolfgang Grandegger  <[email protected]>
 
 	* ksrc/drivers/can/mscan/rtcan_mscan.c (rtcan_mscan_exit): Fix
skins/native/pipe.c +0 -2
Index: ksrc/skins/native/pipe.c
===================================================================
@@ -441,8 +441,6 @@
  *
  * - -EINVAL is returned if @a pipe is not a pipe descriptor.
  *
- * - -EIDRM is returned if @a pipe was closed while reading.
- *
  * - -ENODEV or -EBADF are returned if @a pipe is scrambled.
  *
  * - -ETIMEDOUT is returned if @a timeout is different from
ChangeLog +6 -0
Index: ChangeLog
===================================================================
@@ -1,3 +1,9 @@
+2008-05-27  Sebastian Smolorz  <[email protected]>
+
+	* ksrc/skins/native/pipe.c (rt_pipe_receive): Fix documentation
+	for the return values of the function. -EIDRM is no valid return
+	value any more.
+
 2008-05-25  Roland Stigge  <[email protected]>
 
 	* doc/man/*: Add new manual pages.
skins/native/pipe.c +0 -2
Index: ksrc/skins/native/pipe.c
===================================================================
@@ -441,8 +441,6 @@
  *
  * - -EINVAL is returned if @a pipe is not a pipe descriptor.
  *
- * - -EIDRM is returned if @a pipe was closed while reading.
- *
  * - -ENODEV or -EBADF are returned if @a pipe is scrambled.
  *
  * - -ETIMEDOUT is returned if @a timeout is different from
#1 lore raw
Quoted 4 lines · Sebastian Smolorz

Hi,

rt_pipe_receive() doesn't return -EIDRM any more. The patches for trunk and v2.4.x correct the API documentation in this regard.

Both applied, thanks.

Signature · 1 line
					    Gilles.