index.rst 2.5 KB
Newer Older
1 2 3 4 5
.. The Linux Kernel documentation master file, created by
   sphinx-quickstart on Fri Feb 12 13:51:46 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

6 7
Welcome to The Linux Kernel's documentation
===========================================
8

9 10 11 12 13 14 15 16 17 18 19 20
This is the top level of the kernel's documentation tree.  Kernel
documentation, like the kernel itself, is very much a work in progress;
that is especially true as we work to integrate our many scattered
documents into a coherent whole.  Please note that improvements to the
documentation are welcome; join the linux-doc list at vger.kernel.org if
you want to help out.

User-oriented documentation
---------------------------

The following manuals are written for *users* of the kernel — those who are
trying to get it to work optimally on a given system.
21 22 23 24

.. toctree::
   :maxdepth: 2

25
   admin-guide/index
26

27 28 29 30 31 32 33 34 35 36 37 38
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	      


39 40 41 42 43 44 45 46 47 48 49 50
Introduction to kernel development
----------------------------------

These manuals contain overall information about how to develop the kernel.
The kernel community is quite large, with thousands of developers
contributing over the course of a year.  As with any large community,
knowing how things are done will make the process of getting your changes
merged much easier.

.. toctree::
   :maxdepth: 2

51
   process/index
52
   dev-tools/index
53
   doc-guide/index
54 55 56 57 58 59 60 61

Kernel API documentation
------------------------

These books get into the details of how specific kernel subsystems work
from the point of view of a kernel developer.  Much of the information here
is taken directly from the kernel source, with supplemental material added
as needed (or at least as we managed to add it — probably *not* all that is
62
needed).
63 64 65 66

.. toctree::
   :maxdepth: 2

J
Jonathan Corbet 已提交
67
   driver-api/index
68
   core-api/index
69
   media/index
70
   gpu/index
71
   security/index
72
   sound/index
73
   crypto/index
74

75 76 77 78 79 80 81 82
Korean translations
-------------------

.. toctree::
   :maxdepth: 1

   translations/ko_KR/index

83 84 85 86 87 88 89 90
Chinese translations
--------------------

.. toctree::
   :maxdepth: 1

   translations/zh_CN/index

91 92 93 94 95 96 97 98
Japanese translations
---------------------

.. toctree::
   :maxdepth: 1

   translations/ja_JP/index

99 100 101 102
Indices and tables
==================

* :ref:`genindex`