Skip to content

Prepare files under Documentation/*.txt to build with Sphinx

Mauro Carvalho Chehab linux-arch linux-doc lkml 1 version Applied

Status from this message: I've applied this set, thanks.

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest8 patches 8 repliesApplied

Patches in v1 Applied

#Subject and filesSizeRepliesApplied
1/8docs: DMA-API-HOWTO: add a missing "="Documentation/DMA-API-HOWTO.txt+1 -10 replies
2/8docs: atomic_bitops.txt: add a title for this documentDocumentation/atomic_bitops.txt+3 -30 replies
3/8docs: clearing-warn-once.txt: add a title for this documentDocumentation/clearing-warn-once.txt+2 -00 replies
4/8docs: ntb.txt: use Sphinx notation for the two ascii figuresDocumentation/ntb.txt+6 -40 replies
5/8docs: unaligned-memory-access.txt: use a lowercase titleDocumentation/unaligned-memory-access.txt+1 -10 replies
6/8docs: video-output.txt: convert it to ReST formatDocumentation/video-output.txt+26 -260 replies
7/8docs: ntb.txt: add blank lines to clean up some Sphinx warningsDocumentation/ntb.txt+4 -00 replies
8/8docs: speculation.txt: mark example blocks as suchDocumentation/speculation.txt+4 -40 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 0/8] Prepare files under Documentation/*.txt to build with Sphinx

In the past, we did some efforts to ensure that almost all files under Documentation/*.txt could be built with Sphinx.

Some regressions happened there (and some new files got added). Fix those files in order to allow them to be able to build with Sphinx.

The changes on this series are trivial, adding the minimum stuff to allow building those files with sphinx-build with no warnings and to make the contents minimally consistent with other documentation files.

Mauro Carvalho Chehab (8):
docs: DMA-API-HOWTO: add a missing "="
docs: atomic_bitops.txt: add a title for this document
docs: clearing-warn-once.txt: add a title for this document
docs: ntb.txt: use Sphinx notation for the two ascii figures
docs: unaligned-memory-access.txt: use a lowercase title
docs: video-output.txt: convert it to ReST format
docs: ntb.txt: add blank lines to clean up some Sphinx warnings
docs: speculation.txt: mark example blocks as such

 Documentation/DMA-API-HOWTO.txt           |  2 +-
 Documentation/atomic_bitops.txt           |  6 +--
 Documentation/clearing-warn-once.txt      |  2 +
 Documentation/ntb.txt                     | 14 ++++--
 Documentation/speculation.txt             |  8 ++--
 Documentation/unaligned-memory-access.txt |  2 +-
 Documentation/video-output.txt            | 52 +++++++++++------------
 7 files changed, 47 insertions(+), 39 deletions(-)
Signature · 1 line
2.20.1