summaryrefslogtreecommitdiff
path: root/Documentation/filesystems/splice.rst
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2019-02-20 15:29:36 -0700
committerJonathan Corbet <corbet@lwn.net>2019-03-06 09:46:10 -0700
commit4064174becc09a5a2385a27c8a6fd40888b0e13c (patch)
treef2320919f5088bca1746ca8e655cfd97304af3e2 /Documentation/filesystems/splice.rst
parent866d65b9d72f117134197712dca9c2569b703365 (diff)
docs: Bring some order to filesystem documentation
Documentation/filesystems is, like much of the rest of the kernel's documentation, a jumble of unorganized information. Split the documentation into categories and try to bring some order to the top-level index.rst files. No text changes other than a few section-introductory blurbs; this is all just moving stuff around. Cc: linux-fsdevel@vger.kernel.org Cc: Al Viro <viro@zeniv.linux.org.uk> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Diffstat (limited to 'Documentation/filesystems/splice.rst')
-rw-r--r--Documentation/filesystems/splice.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/Documentation/filesystems/splice.rst b/Documentation/filesystems/splice.rst
new file mode 100644
index 000000000000..edd874808472
--- /dev/null
+++ b/Documentation/filesystems/splice.rst
@@ -0,0 +1,22 @@
+================
+splice and pipes
+================
+
+splice API
+==========
+
+splice is a method for moving blocks of data around inside the kernel,
+without continually transferring them between the kernel and user space.
+
+.. kernel-doc:: fs/splice.c
+
+pipes API
+=========
+
+Pipe interfaces are all for in-kernel (builtin image) use. They are not
+exported for use by modules.
+
+.. kernel-doc:: include/linux/pipe_fs_i.h
+ :internal:
+
+.. kernel-doc:: fs/pipe.c