linux-kernel - Re: [PATCH 18/57] docs: kbuild: convert it to ReST output

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: <20190418072626.3727c56a@coco.lan>
Date:   Thu, 18 Apr 2019 07:26:42 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Masahiro Yamada <yamada.masahiro@...ionext.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>,
        Michal Marek <michal.lkml@...kovi.net>,
        Linux Kbuild mailing list <linux-kbuild@...r.kernel.org>
Subject: Re: [PATCH 18/57] docs: kbuild: convert it to ReST output

Em Thu, 18 Apr 2019 18:25:45 +0900
Masahiro Yamada <yamada.masahiro@...ionext.com> escreveu:

> On Tue, Apr 16, 2019 at 12:01 PM Mauro Carvalho Chehab
> <mchehab+samsung@...nel.org> wrote:
> >
> > The kbuild documentation clearly shows that the documents
> > there are written at different times: some use markdown,
> > some use their own peculiar logic to split sections.
> >
> > Convert everything to ReST without affecting too much
> > the author's style and avoiding adding uneeded markups.  
> 
> Sorry for my ignorance, but shouldn't ReST use
> the extension '.rst' instead of '.txt' ?

Yes. I have a patch with the rename step, but the problem is that doing
such renames on 57 different subdirs and then adding all of them to the
existing index.rst files (in order to add into a bookset) would cause
huge merge conflicts - and keeping them renamed without adding into
an index would cause a *lot* new warnings when building them.

So, IMO, the best would be to have the fixup stuff merged first, and
then do the renames/merges at once, after subsystem maintainers
pick the patches from this rst fixup series.

If you want to see the renaming patch, it is at:
	https://git.linuxtv.org/mchehab/experimental.git/commit/?h=all_with_indexes-v3&id=9cfeb3eb6d48d1aeff9d2ddd84880ab1dc782b00

(I'll probably split it later into per-subdir renames)

The results of this patch, plus the rename one, is at:

	https://www.infradead.org/~mchehab/rst_conversion/kbuild/index.html

> 
> 
> 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
> > ---
> >  Documentation/kbuild/headers_install.txt      |   5 +-
> >  Documentation/kbuild/kbuild.txt               | 119 ++--
> >  Documentation/kbuild/kconfig-language.txt     | 232 ++++----
> >  .../kbuild/kconfig-macro-language.txt         |  37 +-
> >  Documentation/kbuild/kconfig.txt              | 136 +++--
> >  Documentation/kbuild/makefiles.txt            | 518 +++++++++++-------
> >  Documentation/kbuild/modules.txt              | 166 +++---
> >  7 files changed, 720 insertions(+), 493 deletions(-)
> >  
> 



Thanks,
Mauro