[PATCH] docbook: add pipes, other fixes

[PATCH] docbook: add pipes, other fixes

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Fix some typos in pipe.c and splice.c.
Add pipes API to kernel-api.tmpl.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/DocBook/kernel-api.tmpl |   13 +++++++++++--
 fs/pipe.c                             |    2 +-
 fs/splice.c                           |    4 ++--
 3 files changed, 14 insertions(+), 5 deletions(-)

--- linux-2623-rc1g2.orig/fs/pipe.c
+++ linux-2623-rc1g2/fs/pipe.c
@@ -255,7 +255,7 @@ void generic_pipe_buf_get(struct pipe_in
 
 /**
  * generic_pipe_buf_confirm - verify contents of the pipe buffer
- * @pipe:	the pipe that the buffer belongs to
+ * @info:	the pipe that the buffer belongs to
  * @buf:	the buffer to confirm
  *
  * Description:
--- linux-2623-rc1g2.orig/fs/splice.c
+++ linux-2623-rc1g2/fs/splice.c
@@ -164,7 +164,7 @@ static const struct pipe_buf_operations 
  * @spd:	data to fill
  *
  * Description:
- *    @spd contains a map of pages and len/offset tupples, a long with
+ *    @spd contains a map of pages and len/offset tuples, along with
  *    the struct pipe_buf_operations associated with these pages. This
  *    function will link that data to the pipe.
  *
@@ -1000,7 +1000,7 @@ static long do_splice_to(struct file *in
  * Description:
  *    This is a special case helper to splice directly between two
  *    points, without requiring an explicit pipe. Internally an allocated
- *    pipe is cached in the process, and reused during the life time of
+ *    pipe is cached in the process, and reused during the lifetime of
  *    that process.
  *
  */
--- linux-2623-rc1g2.orig/Documentation/DocBook/kernel-api.tmpl
+++ linux-2623-rc1g2/Documentation/DocBook/kernel-api.tmpl
@@ -704,14 +704,23 @@ X!Idrivers/video/console/fonts.c
 
   <chapter id="splice">
       <title>splice API</title>
-  <para>)
+  <para>
 	splice is a method for moving blocks of data around inside the
-	kernel, without continually transferring it between the kernel
+	kernel, without continually transferring them between the kernel
 	and user space.
   </para>
 !Iinclude/linux/splice.h
 !Ffs/splice.c
   </chapter>
 
+  <chapter id="pipes">
+      <title>pipes API</title>
+  <para>
+	Pipe interfaces are all for in-kernel (builtin image) use.
+	They are not exported for use by modules.
+  </para>
+!Iinclude/linux/pipe_fs_i.h
+!Ffs/pipe.c
+  </chapter>
 
 </book>

Re: [PATCH] docbook: add pipes, other fixes

[Jens Axboe]

On Thu, Jul 26 2007, Randy Dunlap wrote:
> From: Randy Dunlap <randy.dunlap@oracle.com>
> 
> Fix some typos in pipe.c and splice.c.
> Add pipes API to kernel-api.tmpl.

Thanks Randy, applied.

-- 
Jens Axboe