[PULL] Documentation format standardization
From: Jonathan Corbet
Date: Sat Jul 15 2017 - 15:15:43 EST
Here's a request to consider as an end-of-window pull. Mauro has gone
through and fixed up a lot of top-level documentation files to make them
conform to the RST format, but without moving or renaming them in any
way. This will help when we incorporate the ones we want to keep into the
Sphinx doctree, but the real purpose is to bring a bit of uniformity to
our documentation and let the top-level docs serve as examples for those
writing new ones.
It touches a lot of files, but it's all contained within Documentation/.
I've held it until now to minimize the chances of conflicts with other
trees changing the docs.
Thanks,
jon
The following changes since commit b86faee6d111294fa95a2e89b5f771b2da3c9782:
Merge tag 'nfs-for-4.13-1' of git://git.linux-nfs.org/projects/anna/linux-nfs (2017-07-13 14:35:37 -0700)
are available in the git repository at:
git://git.lwn.net/linux.git tags/standardize-docs
for you to fetch changes up to 43e5f7e1fa66531777c49791014c3124ea9208d8:
docs: kprobes.txt: Fix whitespacing (2017-07-14 13:58:14 -0600)
----------------------------------------------------------------
This series converts a number of top-level documents to the RST format
without incorporating them into the Sphinx tree. The hope is to bring some
uniformity to kernel documentation and, perhaps more importantly, have our
existing docs serve as an example of the desired formatting for those that
will be added later.
----------------------------------------------------------------
Mauro Carvalho Chehab (84):
bcache.txt: standardize document format
bt8xxgpio.txt: standardize document format
btmrvl.txt: standardize document format
bus-virt-phys-mapping.txt: standardize document format
cachetlb.txt: standardize document format
circular-buffers.txt: standardize document format
clk.txt: standardize document format
cpu-load: standardize document format
cputopology.txt: standardize document format
crc32.txt: standardize document format
dcdbas.txt: standardize document format
digsig.txt: standardize document format
DMA-API.txt: standardize document format
DMA-API-HOWTO.txt: standardize document format
DMA-attributes.txt: standardize document format
DMA-ISA-LPC.txt: standardize document format
debugging-via-ohci1394.txt: standardize document format
efi-stub.txt: standardize document format
eisa.txt: standardize document format
flexible-arrays.txt: standardize document format
futex-requeue-pi.txt: standardize document format
gcc-plugins.txt: standardize document format
highuid.txt: standardize document format
hw_random.txt: standardize document format
hwspinlock.txt: standardize document format
intel_txt.txt: standardize document format
Intel-IOMMU.txt: standardize document format
io-mapping.txt: standardize document format
io_ordering.txt: standardize document format
iostats.txt: standardize document format
iostats.txt: update it to cover recent Kernels
IPMI.txt: standardize document format
IRQ-affinity.txt: standardize document format
IRQ-domain.txt: standardize document format
irqflags-tracing.txt: standardize document format
IRQ.txt: add a markup for its title
isapnp.txt: promote title level
isa.txt: standardize document format
kernel-per-CPU-kthreads.txt: standardize document format
kobject.txt: standardize document format
kprobes.txt: standardize document format
kref.txt: standardize document format
ldm.txt: standardize document format
lockup-watchdogs.txt: standardize document format
lzo.txt: standardize document format
mailbox.txt: standardize document format
memory-hotplug.txt: standardize document format
men-chameleon-bus.txt: standardize document format
nommu-mmap.txt: standardize document format
nommu-mmap.txt: don't use all upper case on titles
ntb.txt: standardize document format
numastat.txt: standardize document format
padata.txt: standardize document format
parport-lowlevel.txt: standardize document format
percpu-rw-semaphore.txt: standardize document format
phy.txt: standardize document format
pi-futex.txt: standardize document format
pnp.txt: standardize document format
preempt-locking.txt: standardize document format
printk-formats.txt: standardize document format
rbtree.txt: standardize document format
remoteproc.txt: standardize document format
rfkill.txt: standardize document format
robust-futex-ABI.txt: standardize document format
robust-futexes.txt: standardize document format
rpmsg.txt: standardize document format
SAK.txt: standardize document format
sgi-ioc4.txt: standardize document format
siphash.txt: standardize document format
SM501.txt: standardize document format
smsc_ece1099.txt: standardize document format
static-keys.txt: standardize document format
svga.txt: standardize document format
this_cpu_ops.txt: standardize document format
unaligned-memory-access.txt: standardize document format
vfio-mediated-device.txt: standardize document format
vfio.txt: standardize document format
xillybus.txt: standardize document format
xz.txt: standardize document format
zorro.txt: standardize document format
dell_rbu.txt: standardize document format
cgroup-v2.txt: standardize document format
tee.txt: standardize document format
docs: kprobes.txt: Fix whitespacing
Documentation/DMA-API-HOWTO.txt | 153 ++--
Documentation/DMA-API.txt | 580 +++++++------
Documentation/DMA-ISA-LPC.txt | 71 +-
Documentation/DMA-attributes.txt | 15 +-
Documentation/IPMI.txt | 76 +-
Documentation/IRQ-affinity.txt | 75 +-
Documentation/IRQ-domain.txt | 69 +-
Documentation/IRQ.txt | 2 +
Documentation/Intel-IOMMU.txt | 37 +-
Documentation/SAK.txt | 65 +-
Documentation/SM501.txt | 9 +-
Documentation/bcache.txt | 190 +++--
Documentation/bt8xxgpio.txt | 19 +-
Documentation/btmrvl.txt | 65 +-
Documentation/bus-virt-phys-mapping.txt | 64 +-
Documentation/cachetlb.txt | 92 +-
Documentation/cgroup-v2.txt | 460 +++++-----
Documentation/circular-buffers.txt | 51 +-
Documentation/clk.txt | 189 +++--
Documentation/cpu-load.txt | 131 +--
Documentation/cputopology.txt | 37 +-
Documentation/crc32.txt | 75 +-
Documentation/dcdbas.txt | 24 +-
Documentation/debugging-via-ohci1394.txt | 21 +-
Documentation/dell_rbu.txt | 81 +-
Documentation/digsig.txt | 131 +--
Documentation/efi-stub.txt | 25 +-
Documentation/eisa.txt | 273 +++---
Documentation/flexible-arrays.txt | 25 +-
Documentation/futex-requeue-pi.txt | 93 +-
Documentation/gcc-plugins.txt | 58 +-
Documentation/highuid.txt | 47 +-
Documentation/hw_random.txt | 159 ++--
Documentation/hwspinlock.txt | 527 +++++++-----
Documentation/intel_txt.txt | 63 +-
Documentation/io-mapping.txt | 67 +-
Documentation/io_ordering.txt | 62 +-
Documentation/iostats.txt | 76 +-
Documentation/irqflags-tracing.txt | 10 +-
Documentation/isa.txt | 53 +-
Documentation/isapnp.txt | 1 +
Documentation/kernel-per-CPU-kthreads.txt | 156 +++-
Documentation/kobject.txt | 69 +-
Documentation/kprobes.txt | 475 ++++++-----
Documentation/kref.txt | 295 ++++---
Documentation/ldm.txt | 56 +-
Documentation/lockup-watchdogs.txt | 3 +-
Documentation/lzo.txt | 27 +-
Documentation/mailbox.txt | 185 ++--
Documentation/memory-hotplug.txt | 355 ++++----
Documentation/men-chameleon-bus.txt | 330 +++----
Documentation/nommu-mmap.txt | 68 +-
Documentation/ntb.txt | 55 +-
Documentation/numastat.txt | 5 +-
Documentation/padata.txt | 27 +-
Documentation/parport-lowlevel.txt | 1321 ++++++++++++++++++-----------
Documentation/percpu-rw-semaphore.txt | 3 +-
Documentation/phy.txt | 106 ++-
Documentation/pi-futex.txt | 15 +-
Documentation/pnp.txt | 343 ++++----
Documentation/preempt-locking.txt | 40 +-
Documentation/printk-formats.txt | 384 +++++----
Documentation/rbtree.txt | 88 +-
Documentation/remoteproc.txt | 328 ++++---
Documentation/rfkill.txt | 43 +-
Documentation/robust-futex-ABI.txt | 14 +-
Documentation/robust-futexes.txt | 12 +-
Documentation/rpmsg.txt | 348 ++++----
Documentation/sgi-ioc4.txt | 4 +
Documentation/siphash.txt | 164 ++--
Documentation/smsc_ece1099.txt | 4 +
Documentation/static-keys.txt | 207 ++---
Documentation/svga.txt | 146 ++--
Documentation/tee.txt | 53 +-
Documentation/this_cpu_ops.txt | 49 +-
Documentation/unaligned-memory-access.txt | 57 +-
Documentation/vfio-mediated-device.txt | 266 +++---
Documentation/vfio.txt | 281 +++---
Documentation/xillybus.txt | 29 +-
Documentation/xz.txt | 200 ++---
Documentation/zorro.txt | 59 +-
81 files changed, 6261 insertions(+), 4730 deletions(-)