From: Andre Noll <maan@systemlinux.org>
Date: Sun, 23 Sep 2007 18:42:31 +0000 (+0200)
Subject: afs.c: Fix documentation of stdin_command().
X-Git-Tag: v0.3.0~367
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=f07fded9f5645a7ac89e63baf50b895cd3a4a140;hp=d5957972a5b29a0e88883244d1745320aba6835a;ds=sidebyside

afs.c: Fix documentation of stdin_command().

It doesn't read from stdin but from the given fd.
---

diff --git a/afs.c b/afs.c
index a95ca415..e109d6c1 100644
--- a/afs.c
+++ b/afs.c
@@ -366,8 +366,9 @@ static int fd2buf(int fd, unsigned max_size, struct osl_object *obj)
 }
 
 /**
- * Read from stdin, and send the result to the parent process.
+ * Read data from a file descriptor, and send it to the afs process.
  *
+ * \param fd File descriptor to read data from.
  * \param arg_obj Pointer to the arguments to \a f.
  * \param f The callback function.
  * \param max_len Don't read more than that many bytes from stdin.
@@ -375,7 +376,7 @@ static int fd2buf(int fd, unsigned max_size, struct osl_object *obj)
  *
  * This function is used by commands that wish to let para_server store
  * arbitrary data specified by the user (for instance the add_blob family of
- * commands). First, at most \a max_len bytes are read from stdin, the result
+ * commands). First, at most \a max_len bytes are read from \a fd, the result
  * is concatenated with the buffer given by \a arg_obj, and the combined buffer
  * is made available to the parent process via shared memory.
  *