linux-kernel - Re: [PATCH 20/57] docs: livepatch: convert it to ReST format

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: Windows password security audit tool. GUI, reports in PDF.

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

Message-ID: <20190416084719.4284d31d@coco.lan>
Date:   Tue, 16 Apr 2019 08:47:19 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Petr Mladek <pmladek@...e.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Josh Poimboeuf <jpoimboe@...hat.com>,
        Jiri Kosina <jikos@...nel.org>,
        Miroslav Benes <mbenes@...e.cz>,
        Joe Lawrence <joe.lawrence@...hat.com>,
        live-patching@...r.kernel.org
Subject: Re: [PATCH 20/57] docs: livepatch: convert it to ReST format

Em Tue, 16 Apr 2019 10:43:54 +0200
Petr Mladek <pmladek@...e.com> escreveu:

> On Mon 2019-04-15 23:55:45, Mauro Carvalho Chehab wrote:
> > Convert livepatch documentation to ReST format. The changes
> > are mostly trivial, as the documents are already on a good
> > shape. Just a few markup changes are needed for Sphinx to
> > properly parse the docs.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>  
> 
> Thanks a lot for the conversion. I tried html output and
> it looks very well.
> 
> Just a question. This patch does only the formatting.
> The documentation is not really generated because the file
> is not renamed to .rst. Also it is not referenced from
> any top level documents. Is it by intention?

Yes. The rationale is simple: renaming to .rst would require
to add them on an index file (or otherwise build would produce lots
of warnings). As this series is doing a lot of such conversions,
assuming that some of those patches will go through different
trees, that would cause lots of conflicts at the main index files.

So, it sounds better to apply the conversion first and then,
on a better moment (maybe late during the merge window), do the
rename and add to the index files.

> 
> 
> I am happy even for the conversion, so:
> 
> Reviewed-by: Petr Mladek <pmladek@...e.com>
> 
> Best Regards,
> Petr



Thanks,
Mauro