linux-kernel - Re: [PATCH 00/10] Add all documentation files to an html/pdf produced book

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: <20190408161820.6a12657f@lwn.net>
Date:   Mon, 8 Apr 2019 16:18:20 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 00/10] Add all documentation files to an html/pdf
 produced book

On Mon,  8 Apr 2019 13:58:16 -0300
Mauro Carvalho Chehab <mchehab+samsung@...nel.org> wrote:

> Despite having converted almost all files to ReST at the main Documentation/
> directory, they're still not included to any book. Also, after all those years
> after migrated to ReST as the official documentation format, there are still
> a lot of files using plain TXT files, with random internal formatting.
> 
> As it will likely require a lot more years to get everything converted,
> let's add index.rst files to Documentation/* subdirs, with a text_files.rst
> including all plain txt files as literal includes.
> 
> That ensures that the html output will contain the entire Linux Kernel
> documentation.

Hmm...

>  251 files changed, 5262 insertions(+), 47 deletions(-)

Somebody clearly thinks I haven't been involved in enough merge conflicts
recently :)

I understand the goal, but I have to wonder.  This feels a lot like giving
up on the problem and just sweeping the remaining junk into a pile
somewhere.  I feel like it would, if anything, reduce the incentive to
deal with these leftover documents properly.  

If this is *really* something we want to do, I would much rather proceed
in smaller steps and preferably with the cooperation of the maintainers
involved.  Imposing all of this at once just seems like a way to make it
highly dangerous for me to show my face a conferences...

Thoughts?

Thanks,

jon