Skip to content

Convert DocBook documents to ReST

Mauro Carvalho Chehab alsa-devel linux-crypto linux-ext4 linux-fsdevel linux-ide linux-s390 linux-scsi lkml netdev 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest36 patches 32 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/36docs-rst: convert kernel-hacking to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/kernel-hacking.tmpl Documentation/conf.py +3 more+808 -13133 replies
2/36kernel-hacking: update documentDocumentation/kernel-hacking/index.rst+98 -810 replies
3/36docs-rst: convert kernel-locking to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/kernel-locking.tmpl Documentation/kernel-hacking/hacking.rst +2 more+2268 -29623 replies
4/36mutex, futex: adjust kernel-doc markups to generate ReSTinclude/linux/mutex.h kernel/futex.c kernel/locking/mutex.c+27 -2517 replies
5/36locking.rst: reformat locking tableDocumentation/kernel-hacking/locking.rst+14 -230 replies
6/36locking.rst: add captions to two tablesDocumentation/kernel-hacking/locking.rst+34 -320 replies
7/36locking.rst: Update some ReST markupsDocumentation/kernel-hacking/locking.rst+8 -80 replies
8/36docs-rst: convert kgdb DocBook to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/kgdb.tmpl Documentation/dev-tools/index.rst +1 more+932 -9190 replies
9/36kgdb.rst: Adjust ReST markupsDocumentation/dev-tools/kgdb.rst+233 -2560 replies
10/36conf.py: define a color for important markup on PDF outputDocumentation/conf.py+7 -10 replies
11/36docs-rst: conf.py: sort LaTeX documents in alphabetical orderDocumentation/conf.py+7 -60 replies
12/36docs-rst: conf.py: remove kernel-documentation from LaTeXDocumentation/conf.py+0 -20 replies
13/36docs-rst: add crypto API book to pdf outputDocumentation/conf.py Documentation/crypto/conf.py+12 -00 replies
14/36docs-rst: add dev-tools book to pdf outputDocumentation/conf.py+2 -00 replies
15/36docs-rst: add sound book to pdf outputDocumentation/conf.py Documentation/sound/conf.py+12 -00 replies
16/36docs-rst: add userspace API book to pdf outputDocumentation/conf.py+2 -00 replies
17/36docs-rst: convert filesystems book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/filesystems.tmpl Documentation/conf.py +3 more+328 -3820 replies
18/36docs-rst: filesystems: use c domain references where neededDocumentation/filesystems/index.rst+40 -360 replies
19/36fs: jbd2: make jbd2_journal_start() kernel-doc parseablefs/jbd2/transaction.c+19 -191 reply
20/36docs-rst: don't ignore internal functions for jbd2 docsDocumentation/filesystems/index.rst+0 -10 replies
21/36fs: locks: Fix some troubles at kernel-doc commentsfs/locks.c+8 -103 replies
22/36fs: add a blank lines on some kernel-doc commentsfs/fs-writeback.c fs/mpage.c fs/namei.c+9 -50 replies
23/36fs: eventfd: fix identation on kernel-docfs/eventfd.c+2 -20 replies
24/36fs: jbd2: escape a string with special chars on a kernel-docfs/jbd2/transaction.c+2 -21 reply
25/36docs-rst: convert libata book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/libata.tmpl Documentation/driver-api/index.rst +1 more+1029 -16260 replies
26/36libata.rst: add c function and struct cross-referencesDocumentation/driver-api/libata.rst+124 -1200 replies
27/36libata: fix identation on a kernel-doc markupdrivers/ata/libata-scsi.c+4 -30 replies
28/36docs-rst: convert s390-drivers DocBook to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/s390-drivers.tmpl Documentation/driver-api/index.rst +1 more+113 -1622 replies
29/36docs-rst: convert networking book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/networking.tmpl Documentation/conf.py +4 more+177 -1120 replies
30/36net: skbuff.h: properly escape a macro name on kernel-docinclude/linux/skbuff.h+1 -10 replies
31/36net: fix some identation issues at kernel-doc markupsdrivers/net/phy/phy.c include/linux/netdevice.h include/net/sock.h +2 more+16 -120 replies
32/36docs-rst: convert z8530book DocBook to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/z8530book.tmpl Documentation/networking/index.rst +1 more+259 -3720 replies
33/36docs-rst: convert scsi DocBook to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/scsi.tmpl Documentation/driver-api/index.rst +2 more+352 -4180 replies
34/36scsi: fix some kernel-doc markupsdrivers/scsi/scsi_scan.c drivers/scsi/scsi_transport_fc.c drivers/scsi/scsicam.c+16 -130 replies
35/36docs-rst: convert w1 book to ReSTDocumentation/DocBook/w1.tmpl Documentation/driver-api/index.rst Documentation/driver-api/w1.rst+71 -1010 replies
36/36docs-rst: convert rapidio book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/rapidio.tmpl Documentation/driver-api/index.rst +1 more+110 -1570 replies

Reviews trailers per patch

5 of 36 patches have a Reviewed-by or Acked-by.

PatchJeff LaytonDarren Hart (VMware)Cornelia HuckJan Kara
1/36
2/36
3/36
4/36A-b
5/36
6/36
7/36
8/36
9/36
10/36
11/36
12/36
13/36
14/36
15/36
16/36
17/36
18/36
19/36R-b
20/36
21/36R-b
22/36
23/36
24/36R-b
25/36
26/36
27/36
28/36A-b
29/36
30/36
31/36
32/36
33/36
34/36
35/36
36/36

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/36] Convert DocBook documents to ReST

This patch series convert the following books from DocBook to ReST:

- filesystems
- kernel-hacking
- kernel-locking
- kgdb
- libata
- networking
- rapidio
- s390-drivers
- scsi
- w1
- z8530book

It also adjusts some Sphinx-pedantic errors/warnings on some kernel-doc markups.

I also added some patches here to add PDF output for all existing ReST books.

I did my best to check if what's there is not too outdated, but the best is if the subsystem maintainers could check it.

After this series, there are only 4 DocBook remaining conversion:
- librs
- lsm
- mtdnand
- sh

I'll likely convert those remaining ones during this weekend.

-

This patch series is based on docs tree (next branch). The full patch series is on this tree:

https://git.linuxtv.org//mchehab/experimental.git/log/?h=docbook

And the HTML output at:

http://www.infradead.org/~mchehab/kernel_docs/
https://mchehab.fedorapeople.org/kernel_docs/

Mauro Carvalho Chehab (36):
docs-rst: convert kernel-hacking to ReST
kernel-hacking: update document
docs-rst: convert kernel-locking to ReST
mutex, futex: adjust kernel-doc markups to generate ReST locking.rst: reformat locking table
locking.rst: add captions to two tables locking.rst: Update some ReST markups
docs-rst: convert kgdb DocBook to ReST
kgdb.rst: Adjust ReST markups
conf.py: define a color for important markup on PDF output
docs-rst: conf.py: sort LaTeX documents in alphabetical order
docs-rst: conf.py: remove kernel-documentation from LaTeX
docs-rst: add crypto API book to pdf output
docs-rst: add dev-tools book to pdf output
docs-rst: add sound book to pdf output
docs-rst: add userspace API book to pdf output
docs-rst: convert filesystems book to ReST
docs-rst: filesystems: use c domain references where needed
fs: jbd2: make jbd2_journal_start() kernel-doc parseable
docs-rst: don't ignore internal functions for jbd2 docs
fs: locks: Fix some troubles at kernel-doc comments
fs: add a blank lines on some kernel-doc comments
fs: eventfd: fix identation on kernel-doc
fs: jbd2: escape a string with special chars on a kernel-doc
docs-rst: convert libata book to ReST
libata.rst: add c function and struct cross-references
libata: fix identation on a kernel-doc markup
docs-rst: convert s390-drivers DocBook to ReST
docs-rst: convert networking book to ReST
net: skbuff.h: properly escape a macro name on kernel-doc
net: fix some identation issues at kernel-doc markups
docs-rst: convert z8530book DocBook to ReST
docs-rst: convert scsi DocBook to ReST
scsi: fix some kernel-doc markups
docs-rst: convert w1 book to ReST
docs-rst: convert rapidio book to ReST

 Documentation/DocBook/Makefile            |   11 +-
 Documentation/DocBook/filesystems.tmpl    |  381 -----
 Documentation/DocBook/kernel-hacking.tmpl | 1312 ------------------
 Documentation/DocBook/kernel-locking.tmpl | 2151 -----------------------------
 Documentation/DocBook/kgdb.tmpl           |  918 ------------
 Documentation/DocBook/libata.tmpl         | 1625 ----------------------
 Documentation/DocBook/networking.tmpl     |  111 --
 Documentation/DocBook/rapidio.tmpl        |  155 ---
 Documentation/DocBook/s390-drivers.tmpl   |  161 ---
 Documentation/DocBook/scsi.tmpl           |  409 ------
 Documentation/DocBook/w1.tmpl             |  101 --
 Documentation/DocBook/z8530book.tmpl      |  371 -----
 Documentation/conf.py                     |   35 +-
 Documentation/crypto/conf.py              |   10 +
 Documentation/dev-tools/index.rst         |    1 +
 Documentation/dev-tools/kgdb.rst          |  907 ++++++++++++
 Documentation/driver-api/index.rst        |    5 +
 Documentation/driver-api/libata.rst       | 1031 ++++++++++++++
 Documentation/driver-api/rapidio.rst      |  107 ++
 Documentation/driver-api/s390-drivers.rst |  111 ++
 Documentation/driver-api/scsi.rst         |  344 +++++
 Documentation/driver-api/w1.rst           |   70 +
 Documentation/filesystems/conf.py         |   10 +
 Documentation/filesystems/index.rst       |  317 +++++
 Documentation/index.rst                   |    3 +
 Documentation/kernel-hacking/conf.py      |   10 +
 Documentation/kernel-hacking/hacking.rst  |  811 +++++++++++
 Documentation/kernel-hacking/index.rst    |    5 +
 Documentation/kernel-hacking/locking.rst  | 1446 +++++++++++++++++++
 Documentation/networking/conf.py          |   10 +
 Documentation/networking/index.rst        |   18 +
 Documentation/networking/kapi.rst         |  147 ++
 Documentation/networking/z8530book.rst    |  256 ++++
 Documentation/sound/conf.py               |   10 +
 drivers/ata/libata-scsi.c                 |    7 +-
 drivers/net/phy/phy.c                     |    1 +
 drivers/scsi/scsi_scan.c                  |    7 +-
 drivers/scsi/scsi_transport_fc.c          |   18 +-
 drivers/scsi/scsicam.c                    |    4 +-
 fs/eventfd.c                              |    4 +-
 fs/fs-writeback.c                         |   12 +-
 fs/jbd2/transaction.c                     |   42 +-
 fs/locks.c                                |   18 +-
 fs/mpage.c                                |    1 +
 fs/namei.c                                |    1 +
 include/linux/mutex.h                     |    6 +-
 include/linux/netdevice.h                 |    9 +-
 include/linux/skbuff.h                    |    2 +-
 include/net/sock.h                        |    9 +-
 kernel/futex.c                            |   40 +-
 kernel/locking/mutex.c                    |    6 +-
 net/core/datagram.c                       |    2 +-
 net/core/sock.c                           |    7 +-
 53 files changed, 5764 insertions(+), 7802 deletions(-)
 delete mode 100644 Documentation/DocBook/filesystems.tmpl
 delete mode 100644 Documentation/DocBook/kernel-hacking.tmpl
 delete mode 100644 Documentation/DocBook/kernel-locking.tmpl
 delete mode 100644 Documentation/DocBook/kgdb.tmpl
 delete mode 100644 Documentation/DocBook/libata.tmpl
 delete mode 100644 Documentation/DocBook/networking.tmpl
 delete mode 100644 Documentation/DocBook/rapidio.tmpl
 delete mode 100644 Documentation/DocBook/s390-drivers.tmpl
 delete mode 100644 Documentation/DocBook/scsi.tmpl
 delete mode 100644 Documentation/DocBook/w1.tmpl
 delete mode 100644 Documentation/DocBook/z8530book.tmpl
 create mode 100644 Documentation/crypto/conf.py
 create mode 100644 Documentation/dev-tools/kgdb.rst
 create mode 100644 Documentation/driver-api/libata.rst
 create mode 100644 Documentation/driver-api/rapidio.rst
 create mode 100644 Documentation/driver-api/s390-drivers.rst
 create mode 100644 Documentation/driver-api/scsi.rst
 create mode 100644 Documentation/driver-api/w1.rst
 create mode 100644 Documentation/filesystems/conf.py
 create mode 100644 Documentation/filesystems/index.rst
 create mode 100644 Documentation/kernel-hacking/conf.py
 create mode 100644 Documentation/kernel-hacking/hacking.rst
 create mode 100644 Documentation/kernel-hacking/index.rst
 create mode 100644 Documentation/kernel-hacking/locking.rst
 create mode 100644 Documentation/networking/conf.py
 create mode 100644 Documentation/networking/index.rst
 create mode 100644 Documentation/networking/kapi.rst
 create mode 100644 Documentation/networking/z8530book.rst
 create mode 100644 Documentation/sound/conf.py
Signature · 1 line
2.9.3