diff mbox series

[1/2] docs: Create a user-space API guide

Message ID 20170402212407.12021-2-corbet@lwn.net
State New
Headers show
Series Create an initial user-space API manual | expand

Commit Message

Jonathan Corbet April 2, 2017, 9:24 p.m. UTC 
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>

---
 Documentation/index.rst               | 12 ++++++++++++
 Documentation/userspace-api/conf.py   | 10 ++++++++++
 Documentation/userspace-api/index.rst | 24 ++++++++++++++++++++++++
 3 files changed, 46 insertions(+)
 create mode 100644 Documentation/userspace-api/conf.py
 create mode 100644 Documentation/userspace-api/index.rst

-- 
2.9.3
diff mbox series

Patch

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`