summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJonathan Corbet <corbet@lwn.net>2017-04-02 14:58:01 -0600
committerJonathan Corbet <corbet@lwn.net>2017-04-02 15:16:58 -0600
commit1d596dee3862bc14895ba15afe69c4e85c6d6124 (patch)
tree909276350df7981b8d9139830fb6c3e8a20aa247
parent0e056eb5530da802c07f080d6bbd43c50e799efd (diff)
downloadlinux-1d596dee3862bc14895ba15afe69c4e85c6d6124.tar.bz2
docs: Create a user-space API guide
This is meant to be the place for documentation relevant to application developers. It's empty for the moment, but at least we have a place now! Signed-off-by: Jonathan Corbet <corbet@lwn.net>
-rw-r--r--Documentation/index.rst12
-rw-r--r--Documentation/userspace-api/conf.py10
-rw-r--r--Documentation/userspace-api/index.rst24
3 files changed, 46 insertions, 0 deletions
diff --git a/Documentation/index.rst b/Documentation/index.rst
index f6e641a54bbc..12550cc1e2a3 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -24,6 +24,18 @@ trying to get it to work optimally on a given system.
admin-guide/index
+Application-developer documentation
+-----------------------------------
+
+The user-space API manual gathers together documents describing aspects of
+the kernel interface as seen by application developers.
+
+.. toctree::
+ :maxdepth: 2
+
+ userspace-api/index
+
+
Introduction to kernel development
----------------------------------
diff --git a/Documentation/userspace-api/conf.py b/Documentation/userspace-api/conf.py
new file mode 100644
index 000000000000..2eaf59f844e5
--- /dev/null
+++ b/Documentation/userspace-api/conf.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = "The Linux kernel user-space API guide"
+
+tags.add("subproject")
+
+latex_documents = [
+ ('index', 'userspace-api.tex', project,
+ 'The kernel development community', 'manual'),
+]
diff --git a/Documentation/userspace-api/index.rst b/Documentation/userspace-api/index.rst
new file mode 100644
index 000000000000..6d98ea6c0d2d
--- /dev/null
+++ b/Documentation/userspace-api/index.rst
@@ -0,0 +1,24 @@
+=====================================
+The Linux kernel user-space API guide
+=====================================
+
+.. _man-pages: https://www.kernel.org/doc/man-pages/
+
+While much of the kernel's user-space API is documented elsewhere
+(particularly in the man-pages_ project), some user-space information can
+also be found in the kernel tree itself. This manual is intended to be the
+place where this information is gathered.
+
+.. class:: toc-title
+
+ Table of contents
+
+.. toctree::
+ :maxdepth: 2
+
+.. only:: subproject and html
+
+ Indices
+ =======
+
+ * :ref:`genindex`