summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJens Axboe <jens.axboe@oracle.com>2007-06-21 13:10:21 +0200
committerJens Axboe <jens.axboe@oracle.com>2007-07-10 08:04:15 +0200
commit932cc6d4f7c35bbf70bce8cc865b6033ff49c9c0 (patch)
tree0f4f22ec4fc55f31460dc68a293efc18077a8c12 /Documentation
parentd6f517568f9f5c26e7404a336c7289d5b4b293ec (diff)
downloadlinux-3.10-932cc6d4f7c35bbf70bce8cc865b6033ff49c9c0.tar.gz
linux-3.10-932cc6d4f7c35bbf70bce8cc865b6033ff49c9c0.tar.bz2
linux-3.10-932cc6d4f7c35bbf70bce8cc865b6033ff49c9c0.zip
splice: completely document external interface with kerneldoc
Also add fs/splice.c as a kerneldoc target with a smaller blurb that should be expanded to better explain the overview of splice. Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/DocBook/kernel-api.tmpl11
1 files changed, 11 insertions, 0 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl
index 38f88b6ae40..8c5698a8c2e 100644
--- a/Documentation/DocBook/kernel-api.tmpl
+++ b/Documentation/DocBook/kernel-api.tmpl
@@ -643,4 +643,15 @@ X!Idrivers/video/console/fonts.c
!Edrivers/spi/spi.c
</chapter>
+ <chapter id="splice">
+ <title>splice API</title>
+ <para>)
+ splice is a method for moving blocks of data around inside the
+ kernel, without continually transferring it between the kernel
+ and user space.
+ </para>
+!Iinclude/linux/splice.h
+!Ffs/splice.c
+ </chapter>
+
</book>