Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1509942
| From | Jonathan Corbet <corbet@lwn.net> |
|---|---|
| Newsgroups | linux.kernel |
| Subject | [PATCH 00/11] Organize and clean up the admin and process guides |
| Date | 2016-10-27 01:30 +0200 |
| Message-ID | <swFNT-28S-5@gated-at.bofh.it> (permalink) |
| Organization | linux.* mail to news gateway |
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
Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread
[PATCH 00/11] Organize and clean up the admin and process guides Jonathan Corbet <corbet@lwn.net> - 2016-10-27 01:30 +0200
[PATCH 10/11] docs: add a warning to submitting-drivers.rst Jonathan Corbet <corbet@lwn.net> - 2016-10-27 01:30 +0200
Re: [PATCH 10/11] docs: add a warning to submitting-drivers.rst Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-27 02:40 +0200
[PATCH 03/11] docs: Clean up and organize the admin guide a bit Jonathan Corbet <corbet@lwn.net> - 2016-10-27 01:30 +0200
Re: [PATCH 03/11] docs: Clean up and organize the admin guide a bit Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-10-27 02:30 +0200
csiph-web