Skip to content

Standardize doc formats - part 1

Mauro Carvalho Chehab cgroups kernel-hardening linux-crypto linux-mtd linux-remoteproc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest31 patches 5 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/31bcache.txt: standardize document formatDocumentation/bcache.txt+112 -880 replies
2/31bt8xxgpio.txt: standardize document formatDocumentation/bt8xxgpio.txt+7 -120 replies
3/31btmrvl.txt: standardize document formatDocumentation/btmrvl.txt+34 -300 replies
4/31bus-virt-phys-mapping.txt: standardize document formatDocumentation/bus-virt-phys-mapping.txt+37 -260 replies
5/31cachetlb.txt: standardize document formatDocumentation/cachetlb.txt+52 -400 replies
6/31cgroup-v2.txt: standardize document formatDocumentation/cgroup-v2.txt+234 -2153 replies
7/31circular-buffers.txt: standardize document formatDocumentation/circular-buffers.txt+23 -280 replies
8/31clk.txt: standardize document formatDocumentation/clk.txt+106 -830 replies
9/31cpu-load: standardize document formatDocumentation/cpu-load.txt+59 -580 replies
10/31cputopology.txt: standardize document formatDocumentation/cputopology.txt+21 -140 replies
11/31crc32.txt: standardize document formatDocumentation/crc32.txt+41 -340 replies
12/31dcdbas.txt: standardize document formatDocumentation/dcdbas.txt+16 -80 replies
13/31digsig.txt: standardize document formatDocumentation/digsig.txt+64 -600 replies
14/31DMA-API.txt: standardize document formatDocumentation/DMA-API.txt+326 -2490 replies
15/31DMA-API-HOWTO.txt: standardize document formatDocumentation/DMA-API-HOWTO.txt+92 -670 replies
16/31DMA-attributes.txt: standardize document formatDocumentation/DMA-attributes.txt+9 -60 replies
17/31DMA-ISA-LPC.txt: standardize document formatDocumentation/DMA-ISA-LPC.txt+36 -350 replies
18/31debugging-via-ohci1394.txt: standardize document formatDocumentation/debugging-via-ohci1394.txt+11 -100 replies
19/31efi-stub.txt: standardize document formatDocumentation/efi-stub.txt+15 -100 replies
20/31eisa.txt: standardize document formatDocumentation/eisa.txt+143 -1170 replies
21/31flexible-arrays.txt: standardize document formatDocumentation/flexible-arrays.txt+13 -110 replies
22/31futex-requeue-pi.txt: standardize document formatDocumentation/futex-requeue-pi.txt+42 -410 replies
23/31gcc-plugins.txt: standardize document formatDocumentation/gcc-plugins.txt+32 -262 replies
24/31highuid.txt: standardize document formatDocumentation/highuid.txt+24 -220 replies
25/31hw_random.txt: standardize document formatDocumentation/hw_random.txt+86 -720 replies
26/31hwspinlock.txt: standardize document formatDocumentation/hwspinlock.txt+307 -2200 replies
27/31intel_txt.txt: standardize document formatDocumentation/intel_txt.txt+40 -230 replies
28/31Intel-IOMMU.txt: standardize document formatDocumentation/Intel-IOMMU.txt+19 -170 replies
29/31io-mapping.txt: standardize document formatDocumentation/io-mapping.txt+41 -260 replies
30/31io_ordering.txt: standardize document formatDocumentation/io_ordering.txt+32 -290 replies
31/31iostats.txt: standardize document formatDocumentation/iostats.txt+27 -130 replies

Reviews trailers per patch

1 of 31 patches has a Reviewed-by or Acked-by.

PatchKees Cook
1/31
2/31
3/31
4/31
5/31
6/31
7/31
8/31
9/31
10/31
11/31
12/31
13/31
14/31
15/31
16/31
17/31
18/31
19/31
20/31
21/31
22/31
23/31A-b
24/31
25/31
26/31
27/31
28/31
29/31
30/31
31/31

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH 00/31] Standardize doc formats - part 1

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 1.

Mauro Carvalho Chehab (31):
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 cgroup-v2.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

 Documentation/DMA-API-HOWTO.txt          | 159 +++++----
 Documentation/DMA-API.txt                | 575 ++++++++++++++++++-------------
 Documentation/DMA-ISA-LPC.txt            |  71 ++--
 Documentation/DMA-attributes.txt         |  15 +-
 Documentation/Intel-IOMMU.txt            |  36 +-
 Documentation/bcache.txt                 | 200 ++++++-----
 Documentation/bt8xxgpio.txt              |  19 +-
 Documentation/btmrvl.txt                 |  64 ++--
 Documentation/bus-virt-phys-mapping.txt  |  63 ++--
 Documentation/cachetlb.txt               |  92 ++---
 Documentation/cgroup-v2.txt              | 449 ++++++++++++------------
 Documentation/circular-buffers.txt       |  51 ++-
 Documentation/clk.txt                    | 189 +++++-----
 Documentation/cpu-load.txt               | 117 +++----
 Documentation/cputopology.txt            |  35 +-
 Documentation/crc32.txt                  |  75 ++--
 Documentation/dcdbas.txt                 |  24 +-
 Documentation/debugging-via-ohci1394.txt |  21 +-
 Documentation/digsig.txt                 | 124 +++----
 Documentation/efi-stub.txt               |  25 +-
 Documentation/eisa.txt                   | 260 +++++++-------
 Documentation/flexible-arrays.txt        |  24 +-
 Documentation/futex-requeue-pi.txt       |  83 ++---
 Documentation/gcc-plugins.txt            |  58 ++--
 Documentation/highuid.txt                |  46 +--
 Documentation/hw_random.txt              | 158 +++++----
 Documentation/hwspinlock.txt             | 527 ++++++++++++++++------------
 Documentation/intel_txt.txt              |  63 ++--
 Documentation/io-mapping.txt             |  67 ++--
 Documentation/io_ordering.txt            |  61 ++--
 Documentation/iostats.txt                |  40 ++-
 31 files changed, 2101 insertions(+), 1690 deletions(-)
Signature · 1 line
2.9.4