linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH 00/10] Add all documentation files to an html/pdf produced book
Date: Mon, 8 Apr 2019 16:18:20 -0600	[thread overview]
Message-ID: <20190408161820.6a12657f@lwn.net> (raw)
In-Reply-To: <cover.1554742526.git.mchehab+samsung@kernel.org>

On Mon,  8 Apr 2019 13:58:16 -0300
Mauro Carvalho Chehab <mchehab+samsung@kernel.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

  parent reply	other threads:[~2019-04-08 22:18 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-04-08 16:58 [PATCH 00/10] Add all documentation files to an html/pdf produced book Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 01/10] docs: DMA-API-HOWTO: add a missing "=" Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 02/10] docs: atomic_bitops.txt: add a title for this document Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 03/10] docs: clearing-warn-once.txt: " Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 04/10] docs: ntb.txt: use Sphinx notation for the two ascii figures Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 05/10] docs: unaligned-memory-access.txt: use a lowercase title Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 06/10] docs: video-output.txt: convert it to ReST format Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 07/10] docs: Add all txt files to documentation Mauro Carvalho Chehab
2019-04-09 16:47   ` Joe Perches
2019-04-08 16:58 ` [PATCH 08/10] docs: ntb.rst: add blank lines to clean up some Sphinx warnings Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 09/10] docs: speculation.rst: mark example blocks as such Mauro Carvalho Chehab
2019-04-08 16:58 ` [PATCH 10/10] docs: add plain text files to ReST output from subdirs Mauro Carvalho Chehab
2019-04-08 22:18 ` Jonathan Corbet [this message]
2019-04-10  9:49   ` [PATCH 00/10] Add all documentation files to an html/pdf produced book Mauro Carvalho Chehab
2019-04-11 18:49     ` Jonathan Corbet
2019-04-12  9:28       ` Mauro Carvalho Chehab
2019-04-13  0:30         ` Mauro Carvalho Chehab

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20190408161820.6a12657f@lwn.net \
    --to=corbet@lwn.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab+samsung@kernel.org \
    --cc=mchehab@infradead.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).