Merge branch 'tpm' into docs-next

[mirror_ubuntu-artful-kernel.git] / Documentation / index.rst

diff --git a/Documentation/index.rst b/Documentation/index.rst
index b4c3034ebc09fd0a85a940e4186163d7eae0a242..1dff9fa106bdc88a96d3b5113038426ffaaeafe0 100644 (file)
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -3,26 +3,63 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to The Linux Kernel's documentation!
-============================================
+Welcome to The Linux Kernel's documentation
+===========================================
 
-Nothing for you to see here *yet*. Please move along.
+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.
 
-Contents:
+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.
+
+.. toctree::
+   :maxdepth: 2
+
+   admin-guide/index
+
+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
 
+   process/index
+   dev-tools/index
    kernel-documentation
-   media/media_uapi
-   media/media_kapi
-   media/dvb-drivers/index
-   media/v4l-drivers/index
+
+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
+needed). 
+
+.. toctree::
+   :maxdepth: 2
+
+   driver-api/index
+   core-api/index
+   media/index
    gpu/index
+   80211/index
    security/index
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
-* :ref:`search`