linux-kernel - Re: [PATCH 0/5] Convert more books to ReST

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 15 May 2017 14:09:12 +0200
From:   Boris Brezillon <boris.brezillon@...e-electrons.com>
To:     Mauro Carvalho Chehab <mchehab@...pensource.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Rich Felker <dalias@...c.org>, linux-sh@...r.kernel.org,
        Takashi Iwai <tiwai@...e.de>,
        Sebastian Andrzej Siewior <bigeasy@...utronix.de>,
        "Herton R. Krzesinski" <herton@...hat.com>,
        linux-mtd@...ts.infradead.org,
        Cyrille Pitchen <cyrille.pitchen@...el.com>,
        Markus Heiser <markus.heiser@...marit.de>,
        Yoshinori Sato <ysato@...rs.sourceforge.jp>,
        Jonathan Corbet <corbet@....net>,
        Richard Weinberger <richard@....at>,
        Marek Vasut <marek.vasut@...il.com>,
        sayli karnik <karniksayli1995@...il.com>,
        Jani Nikula <jani.nikula@...el.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        linux-kernel@...r.kernel.org,
        linux-security-module@...r.kernel.org,
        Silvio Fricke <silvio.fricke@...il.com>,
        Brian Norris <computersforpeace@...il.com>,
        David Woodhouse <dwmw2@...radead.org>
Subject: Re: [PATCH 0/5] Convert more books to ReST

On Sat, 13 May 2017 08:10:53 -0300
Mauro Carvalho Chehab <mchehab@...pensource.com> wrote:

> 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 maintainers did not receive the above patch. Can you Cc us the
whole series next time.

BTW, I had a look at your branch and it seems the typo you're fixing is
actually not a type. Flags are *OR-ed* (with the | operator) to form a
valid combination of flags.

>   mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings

Not sure how you plan to merge these changes, but if it goes through
a single tree I'll probably need an immutable topic branch, because I
plan to change a few things in nand_base.c nand.h for the next release.

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