From: Jonathan Corbet Date: Thu, 27 Oct 2016 23:05:10 +0000 (-0600) Subject: Merge branch 'doc-tweaks' into docs-next X-Git-Url: https://git.stricted.de/?a=commitdiff_plain;h=9d2cccdd6c226181c42a7bb0c5ede1583687b618;p=GitHub%2Fmoto-9609%2Fandroid_kernel_motorola_exynos9610.git Merge branch 'doc-tweaks' into docs-next 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. --- 9d2cccdd6c226181c42a7bb0c5ede1583687b618 diff --cc Documentation/admin-guide/index.rst index fb779e67097b,2872c0c70ea4..368845e9900a --- a/Documentation/admin-guide/index.rst +++ b/Documentation/admin-guide/index.rst @@@ -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` - diff --cc Documentation/index.rst index 0f98823126f2,7cec8432ce7a..85a66270f96c --- a/Documentation/index.rst +++ b/Documentation/index.rst @@@ -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 diff --cc Documentation/process/index.rst index cddf580671e7,0557144cef2b..10aa6920709a --- a/Documentation/process/index.rst +++ b/Documentation/process/index.rst @@@ -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`