Merge branch 'doc-tweaks' into docs-next
authorJonathan Corbet <corbet@lwn.net>
Thu, 27 Oct 2016 23:05:10 +0000 (17:05 -0600)
committerJonathan Corbet <corbet@lwn.net>
Thu, 27 Oct 2016 23:47:58 +0000 (17:47 -0600)
The creation of the admin and process guides is a great thing, but, without
care, we risk replacing a messy docs directory with a few messy Sphinx
books.  In an attempt to head that off and show what I'm thinking, here's a
set of tweaks that, I think, make the existing Sphinx-formatted docs a bit
more accessible.

1  2 
Documentation/admin-guide/index.rst
Documentation/index.rst
Documentation/process/index.rst

index fb779e67097b9ef99cf94a0795e97ae36b7ecd39,2872c0c70ea4cb780f910a7ce9a38c5d3a860adb..368845e9900a27809bc45fd52b1a1368d7bdd004
@@@ -28,15 -58,3 +58,10 @@@ configure specific aspects of kernel be
     binfmt-misc
     mono
     java
-    bad-memory
-    basic-profiling
 +
 +.. only::  subproject and html
 +
 +   Indices
 +   =======
 +
 +   * :ref:`genindex`
index 0f98823126f2c699b91ee5b8423a2b681af67ed5,7cec8432ce7ae0c9b5a208a6cc55a16cea10a3ce..85a66270f96cefcc06d4280a474bc0f0a954c4ff
@@@ -12,9 -23,35 +23,35 @@@ trying to get it to work optimally on 
     :maxdepth: 2
  
     admin-guide/index
-    kernel-documentation
+ 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/tools
 +   dev-tools/index
+    kernel-documentation
+ 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
     media/index
     gpu/index
index cddf580671e7ed8467ca84b5c72fe3e23a044266,0557144cef2b4e5928d1b554e5a7b10a53bc9221..10aa6920709a462789278f670eee8f8ea68cbc0c
@@@ -29,12 -49,3 +49,9 @@@ lack of a better place
     magic-number
     volatile-considered-harmful
  
-    development-process
 +.. only::  subproject and html
 +
 +   Indices
 +   =======
 +
 +   * :ref:`genindex`