diff options
| -rw-r--r-- | Documentation/index.rst | 12 | ||||
| -rw-r--r-- | Documentation/userspace-api/conf.py | 10 | ||||
| -rw-r--r-- | Documentation/userspace-api/index.rst | 24 |
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. | |||
| 24 | 24 | ||
| 25 | admin-guide/index | 25 | admin-guide/index |
| 26 | 26 | ||
| 27 | Application-developer documentation | ||
| 28 | ----------------------------------- | ||
| 29 | |||
| 30 | The user-space API manual gathers together documents describing aspects of | ||
| 31 | the kernel interface as seen by application developers. | ||
| 32 | |||
| 33 | .. toctree:: | ||
| 34 | :maxdepth: 2 | ||
| 35 | |||
| 36 | userspace-api/index | ||
| 37 | |||
| 38 | |||
| 27 | Introduction to kernel development | 39 | Introduction to kernel development |
| 28 | ---------------------------------- | 40 | ---------------------------------- |
| 29 | 41 | ||
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 @@ | |||
| 1 | # -*- coding: utf-8; mode: python -*- | ||
| 2 | |||
| 3 | project = "The Linux kernel user-space API guide" | ||
| 4 | |||
| 5 | tags.add("subproject") | ||
| 6 | |||
| 7 | latex_documents = [ | ||
| 8 | ('index', 'userspace-api.tex', project, | ||
| 9 | 'The kernel development community', 'manual'), | ||
| 10 | ] | ||
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 @@ | |||
| 1 | ===================================== | ||
| 2 | The Linux kernel user-space API guide | ||
| 3 | ===================================== | ||
| 4 | |||
| 5 | .. _man-pages: https://www.kernel.org/doc/man-pages/ | ||
| 6 | |||
| 7 | While much of the kernel's user-space API is documented elsewhere | ||
| 8 | (particularly in the man-pages_ project), some user-space information can | ||
| 9 | also be found in the kernel tree itself. This manual is intended to be the | ||
| 10 | place where this information is gathered. | ||
| 11 | |||
| 12 | .. class:: toc-title | ||
| 13 | |||
| 14 | Table of contents | ||
| 15 | |||
| 16 | .. toctree:: | ||
| 17 | :maxdepth: 2 | ||
| 18 | |||
| 19 | .. only:: subproject and html | ||
| 20 | |||
| 21 | Indices | ||
| 22 | ======= | ||
| 23 | |||
| 24 | * :ref:`genindex` | ||
