docbook: add pipes, other fixes

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>
Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
This commit is contained in:
Randy Dunlap 2007-07-27 08:08:51 +02:00 committed by Jens Axboe
parent 7c2ff389bb
commit 79685b8dee
3 changed files with 14 additions and 5 deletions

View File

@ -704,14 +704,23 @@ X!Idrivers/video/console/fonts.c
<chapter id="splice"> <chapter id="splice">
<title>splice API</title> <title>splice API</title>
<para>) <para>
splice is a method for moving blocks of data around inside the 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. and user space.
</para> </para>
!Iinclude/linux/splice.h !Iinclude/linux/splice.h
!Ffs/splice.c !Ffs/splice.c
</chapter> </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> </book>

View File

@ -255,7 +255,7 @@ void generic_pipe_buf_get(struct pipe_inode_info *pipe, struct pipe_buffer *buf)
/** /**
* generic_pipe_buf_confirm - verify contents of the pipe buffer * 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 * @buf: the buffer to confirm
* *
* Description: * Description:

View File

@ -164,7 +164,7 @@ static const struct pipe_buf_operations user_page_pipe_buf_ops = {
* @spd: data to fill * @spd: data to fill
* *
* Description: * 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 * the struct pipe_buf_operations associated with these pages. This
* function will link that data to the pipe. * function will link that data to the pipe.
* *
@ -1000,7 +1000,7 @@ static long do_splice_to(struct file *in, loff_t *ppos,
* Description: * Description:
* This is a special case helper to splice directly between two * This is a special case helper to splice directly between two
* points, without requiring an explicit pipe. Internally an allocated * 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. * that process.
* *
*/ */