Skip to content

Convert more books to ReST

Mauro Carvalho Chehab linux-mtd linux-security-module linux-sh lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest5 patches 4 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/5docs-rst: convert librs book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/librs.tmpl Documentation/core-api/index.rst +1 more+214 -2900 replies
2/5docs-rst: convert mtdnand book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/mtdnand.tmpl Documentation/driver-api/index.rst +1 more+1021 -12920 replies
3/5mtdnand.rst: Fix some typos and group the "::" with previous lineDocumentation/driver-api/mtdnand.rst+7 -170 replies
4/5mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warningsDocumentation/driver-api/mtdnand.rst drivers/mtd/nand/nand_base.c include/linux/mtd/nand.h+6 -60 replies
5/5docs-rst: convert sh book to ReSTDocumentation/DocBook/Makefile Documentation/DocBook/sh.tmpl Documentation/conf.py +2 more+73 -1080 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/5] Convert more books to ReST

This patch series convert the following books to ReST:
- librs
- mtdnand
- sh

And it is based on my previous series of conversion patches.

After this series, there will be just one DocBook pending conversion:
- lsm (Linux Security Modules)

This book is very outdated: no changes since the Kernel moved to git, in 2005 (except for a minor editorial fix in 2008).

I took a look on the described API: it doesn't seem to be describing the current security implementation.

The best here is if someone that works with LSM to convert it to ReST with:

	$ Documentation/sphinx/tmplcvt Documentation/DocBook/lsm.tmpl lsm.rst

And fix the document to produce something that reflects the current implementation. If nobody is interested, then maybe we could just drop it.

-

This patch series is based on my past 00/36 patch series, applied on the top of docs tree (next branch).

The full patch series is on this tree is at:

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 (5):
docs-rst: convert librs book to ReST
docs-rst: convert mtdnand book to ReST
mtdnand.rst: Fix some typos and group the "::" with previous line
mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings
docs-rst: convert sh book to ReST

 Documentation/DocBook/Makefile       |    5 +-
 Documentation/DocBook/librs.tmpl     |  289 --------
 Documentation/DocBook/mtdnand.tmpl   | 1291 ----------------------------------
 Documentation/DocBook/sh.tmpl        |  105 ---
 Documentation/conf.py                |    2 +
 Documentation/core-api/index.rst     |    1 +
 Documentation/core-api/librs.rst     |  212 ++++++
 Documentation/driver-api/index.rst   |    1 +
 Documentation/driver-api/mtdnand.rst | 1007 ++++++++++++++++++++++++++
 Documentation/index.rst              |   11 +
 Documentation/sh/index.rst           |   59 ++
 drivers/mtd/nand/nand_base.c         |    7 +-
 include/linux/mtd/nand.h             |    2 +-
 13 files changed, 1300 insertions(+), 1692 deletions(-)
 delete mode 100644 Documentation/DocBook/librs.tmpl
 delete mode 100644 Documentation/DocBook/mtdnand.tmpl
 delete mode 100644 Documentation/DocBook/sh.tmpl
 create mode 100644 Documentation/core-api/librs.rst
 create mode 100644 Documentation/driver-api/mtdnand.rst
 create mode 100644 Documentation/sh/index.rst
Signature · 7 lines
2.9.3


--
To unsubscribe from this list: send the line "unsubscribe linux-security-module" in
the body of a message to majordomo at vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html