linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Christoph Hellwig <hch@infradead.org>
To: Jani Nikula <jani.nikula@intel.com>
Cc: Christoph Hellwig <hch@infradead.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: Re: [PATCH 03/10] docs: sphinxify sparse.txt and move to dev-tools
Date: Tue, 9 Aug 2016 01:22:09 -0700	[thread overview]
Message-ID: <20160809082209.GA7553@infradead.org> (raw)
In-Reply-To: <87lh06xsk9.fsf@intel.com>

On Tue, Aug 09, 2016 at 11:19:50AM +0300, Jani Nikula wrote:
> On Tue, 09 Aug 2016, Christoph Hellwig <hch@infradead.org> wrote:
> > The ugly format is a major regression over a proper simple text
> > file.  What's the point?
> 
> Major regression? Please be reasonable.
> 
> I think the changes are rather small, and it's a fair compromise between
> a simple text file and one that can be used to generate pretty
> documentation [1].

It's a lot less pretty to read - it look like a cat threw up to be
specific.  The point of the Document is to read it quickly in the kernel
tree.  If you want fancy websites write a separate document.

> [1] http://static.lwn.net/kerneldoc/dev-tools/sparse.html

And I wouldn't exactly call that pretty.  There is no value add
over a simple text file here, and it requires a browser to not look
ugly instead of a text editor, which is a giant usablity regression.

  reply	other threads:[~2016-08-09  8:22 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-08-08 23:34 [PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents Jonathan Corbet
2016-08-08 23:34 ` [PATCH 01/10] docs: create a new dev-tools directory Jonathan Corbet
2016-08-08 23:34 ` [PATCH 02/10] docs: sphinxify coccinelle.txt and add it to dev-tools Jonathan Corbet
2016-08-09  5:18   ` Julia Lawall
2016-08-09 13:08   ` Nicolas Palix (LIG)
2016-08-08 23:34 ` [PATCH 03/10] docs: sphinxify sparse.txt and move " Jonathan Corbet
2016-08-09  8:07   ` Christoph Hellwig
2016-08-09  8:19     ` Jani Nikula
2016-08-09  8:22       ` Christoph Hellwig [this message]
2016-08-09  8:28         ` Daniel Vetter
2016-08-09  8:31           ` Christoph Hellwig
2016-08-09 10:00             ` Daniel Vetter
2016-08-09 22:53             ` Jonathan Corbet
2016-08-18 23:46             ` Jonathan Corbet
2016-08-19  2:27               ` Christoph Hellwig
2016-08-08 23:34 ` [PATCH 04/10] docs: sphinxify kcov.txt " Jonathan Corbet
2016-08-08 23:34 ` [PATCH 05/10] docs: sphinixfy gcov.txt " Jonathan Corbet
2016-08-08 23:34 ` [PATCH 06/10] docs: sphinxify kasan.txt " Jonathan Corbet
2016-08-09  9:09   ` Alexander Potapenko
2016-08-17 15:49   ` Andrey Ryabinin
2016-08-08 23:34 ` [PATCH 07/10] docs: sphinxify ubsan.txt and move it " Jonathan Corbet
2016-08-17 15:50   ` Andrey Ryabinin
2016-08-08 23:35 ` [PATCH 08/10] docs: sphinxify kmemleak.txt " Jonathan Corbet
2016-08-10 14:37   ` Catalin Marinas
2016-08-08 23:35 ` [PATCH 09/10] docs: sphinxify kmemcheck.txt and move " Jonathan Corbet
2016-08-09  7:04   ` Vegard Nossum
2016-08-08 23:35 ` [PATCH 10/10] docs: Sphinxify gdb-kernel-debugging.txt " Jonathan Corbet
2016-08-10  7:03   ` Jan Kiszka
2016-08-09  8:50 ` [PATCH 00/10] [RFC] Sphinxify and coalesce development-tool documents Jani Nikula

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=20160809082209.GA7553@infradead.org \
    --to=hch@infradead.org \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.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).