[PATCH 00/11] Organize and clean up the admin and process guides

From: Jonathan Corbet
Date: Wed Oct 26 2016 - 19:23:27 EST


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.

Hopefully none of this is too controversial. That's probably too much to
hope for in the case of the deleted documents, though, since deleting
anything seems to be an uphill battle.

Jonathan Corbet (11):
docs: Tweak the top-level Sphinx page
docs: retitle the kernel-documentation.rst
docs: Clean up and organize the admin guide a bit
docs: Get rid of the badRAM guide
docs: Get rid of the "basic profiling" guide
docs: Get rid of the "bug-hunting" guide
docs: Apply some basic organization to the process guide
docs: Tweak submitting-patches.rst formatting
docs: Collapse the process guide TOC
docs: add a warning to submitting-drivers.rst
docs: Add a warning to applying-patches.rst

Documentation/admin-guide/bad-memory.rst | 50 -----
Documentation/admin-guide/basic-profiling.rst | 68 -------
Documentation/admin-guide/bug-hunting.rst | 249 ------------------------
Documentation/admin-guide/index.rst | 53 +++--
Documentation/admin-guide/kernel-parameters.rst | 4 +-
Documentation/admin-guide/sysfs-rules.rst | 4 +-
Documentation/admin-guide/vga-softcursor.rst | 4 +-
Documentation/index.rst | 45 ++++-
Documentation/kernel-documentation.rst | 6 +-
Documentation/process/applying-patches.rst | 4 +
Documentation/process/changes.rst | 2 +-
Documentation/process/index.rst | 39 +++-
Documentation/process/submitting-drivers.rst | 8 +
Documentation/process/submitting-patches.rst | 16 +-
14 files changed, 137 insertions(+), 415 deletions(-)
delete mode 100644 Documentation/admin-guide/bad-memory.rst
delete mode 100644 Documentation/admin-guide/basic-profiling.rst
delete mode 100644 Documentation/admin-guide/bug-hunting.rst

--
2.7.4