Skip to content

Standardize doc formats - part 2

Mauro Carvalho Chehab linux-crypto linux-mtd lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest30 patches 6 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/30iostats.txt: update it to cover recent KernelsDocumentation/iostats.txt+22 -220 replies
2/30IPMI.txt: standardize document formatDocumentation/IPMI.txt+44 -320 replies
3/30IRQ-affinity.txt: standardize document formatDocumentation/IRQ-affinity.txt+41 -360 replies
4/30IRQ-domain.txt: standardize document formatDocumentation/IRQ-domain.txt+49 -200 replies
5/30irqflags-tracing.txt: standardize document formatDocumentation/irqflags-tracing.txt+6 -40 replies
6/30IRQ.txt: add a markup for its titleDocumentation/IRQ.txt+2 -00 replies
7/30isapnp.txt: promote title levelDocumentation/isapnp.txt+1 -00 replies
8/30isa.txt: standardize document formatDocumentation/isa.txt+27 -263 replies
9/30kernel-per-CPU-kthreads.txt: standardize document formatDocumentation/kernel-per-CPU-kthreads.txt+121 -350 replies
10/30kobject.txt: standardize document formatDocumentation/kobject.txt+42 -271 reply
11/30kprobes.txt: standardize document formatDocumentation/kprobes.txt+265 -1851 reply
12/30kref.txt: standardize document formatDocumentation/kref.txt+150 -1350 replies
13/30kselftest.txt: standardize document formatDocumentation/kselftest.txt+25 -120 replies
14/30ldm.txt: standardize document formatDocumentation/ldm.txt+33 -210 replies
15/30lockup-watchdogs.txt: standardize document formatDocumentation/lockup-watchdogs.txt+2 -10 replies
16/30lzo.txt: standardize document formatDocumentation/lzo.txt+17 -100 replies
17/30mailbox.txt: standardize document formatDocumentation/mailbox.txt+95 -860 replies
18/30memory-barriers.txt: standardize document formatDocumentation/memory-barriers.txt+329 -3310 replies
19/30memory-barriers.txt: use literals for variablesDocumentation/memory-barriers.txt+77 -770 replies
20/30memory-hotplug.txt: standardize document formatDocumentation/memory-hotplug.txt+195 -1620 replies
21/30men-chameleon-bus.txt: standardize document formatDocumentation/men-chameleon-bus.txt+155 -1431 reply
22/30nommu-mmap.txt: standardize document formatDocumentation/nommu-mmap.txt+22 -300 replies
23/30nommu-mmap.txt: don't use all upper case on titlesDocumentation/nommu-mmap.txt+9 -90 replies
24/30ntb.txt: standardize document formatDocumentation/ntb.txt+37 -180 replies
25/30numastat.txt: standardize document formatDocumentation/numastat.txt+4 -10 replies
26/30padata.txt: standardize document formatDocumentation/padata.txt+15 -120 replies
27/30parport-lowlevel.txt: standardize document formatDocumentation/parport-lowlevel.txt+832 -4710 replies
28/30percpu-rw-semaphore.txt: standardize document formatDocumentation/percpu-rw-semaphore.txt+2 -10 replies
29/30phy.txt: standardize document formatDocumentation/phy.txt+67 -390 replies
30/30pi-futex.txt: standardize document formatDocumentation/pi-futex.txt+8 -70 replies

Reviews trailers per patch

4 of 30 patches have a Reviewed-by or Acked-by.

PatchWilliam Breathitt GrayGreg Kroah-HartmanJohannes ThumshirnMasami Hiramatsu
1/30
2/30
3/30
4/30
5/30
6/30
7/30
8/30A-b
9/30
10/30A-b
11/30A-b
12/30
13/30
14/30
15/30
16/30
17/30
18/30
19/30
20/30
21/30A-b
22/30
23/30
24/30
25/30
26/30
27/30
28/30
29/30
30/30

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 4 reviewers.

Read the v1 thread

Cover letter [PATCH 00/30] Standardize doc formats - part 2

Each document under Documentation/*.txt has its own format. Some follow markup notations, some don't even have a title!

In order to try to get some order on it, change the document style to the standard we're adopting after the adoption of ReStructured Text.

The documents touched on this series now build fine with Sphinx, if renamed to *.rst extension.

The main goal with this is to teach people by example about what format is expected on newer documents. It also helps to add those files to Kernel books.

In order to make things more palatable, I'm spliting the conversion into three parts.

This is part 2.

Mauro Carvalho Chehab (30):
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 kselftest.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-barriers.txt: standardize document format memory-barriers.txt: use literals for variables 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

 Documentation/IPMI.txt                    |   76 +-
 Documentation/IRQ-affinity.txt            |   77 +-
 Documentation/IRQ-domain.txt              |   69 +-
 Documentation/IRQ.txt                     |    2 +
 Documentation/iostats.txt                 |   44 +-
 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                 |  450 ++++++----
 Documentation/kref.txt                    |  285 ++++---
 Documentation/kselftest.txt               |   37 +-
 Documentation/ldm.txt                     |   54 +-
 Documentation/lockup-watchdogs.txt        |    3 +-
 Documentation/lzo.txt                     |   27 +-
 Documentation/mailbox.txt                 |  181 ++--
 Documentation/memory-barriers.txt         |  794 +++++++++---------
 Documentation/memory-hotplug.txt          |  357 ++++----
 Documentation/men-chameleon-bus.txt       |  298 +++----
 Documentation/nommu-mmap.txt              |   68 +-
 Documentation/ntb.txt                     |   55 +-
 Documentation/numastat.txt                |    5 +-
 Documentation/padata.txt                  |   27 +-
 Documentation/parport-lowlevel.txt        | 1303 ++++++++++++++++++-----------
 Documentation/percpu-rw-semaphore.txt     |    3 +-
 Documentation/phy.txt                     |  106 ++-
 Documentation/pi-futex.txt                |   15 +-
 28 files changed, 2683 insertions(+), 1942 deletions(-)
Signature · 7 lines
2.9.4



------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot