mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Peter Zijlstra <peterz@infradead.org>
To: LKML <linux-kernel@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>,
	linux-doc@vger.kernel.org, Christoph Hellwig <hch@infradead.org>,
	Jani Nikula <jani.nikula@linux.intel.com>,
	Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Daniel Vetter <daniel.vetter@intel.com>
Subject: Re: [PATCH] doc: Explain light-handed markup preference a bit better
Date: Tue, 6 Dec 2016 08:52:41 +0100	[thread overview]
Message-ID: <20161206075241.GU3092@twins.programming.kicks-ass.net> (raw)
In-Reply-To: <20161129131752.63443vbvoudxe6sy@phenom.ffwll.local>

On Tue, Nov 29, 2016 at 02:17:52PM +0100, Daniel Vetter wrote:
> Hi Peter,
> 
> On Tue, Nov 29, 2016 at 10:23:14AM +0100, Daniel Vetter wrote:
> > We already had a super-short blurb, but worth extending it I think:
> > We're still pretty far away from anything like a consensus, but
> > there's clearly a lot of people who prefer an as-light as possible
> > approach to converting existing .txt files to .rst. Make sure this is
> > properly taken into account and clear.
> > 
> > Motivated by discussions with Peter and Christoph and others.
> > 
> > v2:
> > - Mention that existing headings should be kept when converting
> >   existing .txt files (Mauro).
> > - Explain that we prefer :: for quoting code, it's easier on the
> >   eyes (Mauro).
> > - Explain that blindly converting outdated docs is harmful. Motived
> >   by comments Peter did in our discussion.
> > 
> > Cc: Jonathan Corbet <corbet@lwn.net>
> > Cc: linux-doc@vger.kernel.org
> > Cc: Christoph Hellwig <hch@infradead.org>
> > Cc: Peter Zijlstra <peterz@infradead.org>
> > Cc: Jani Nikula <jani.nikula@linux.intel.com>
> > Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> > Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> 
> Since this was motivated by a discussion you've (re)started, does this
> sufficiently address your concerns for conversion from plain text .txt to
> plain text .rst of existing documents? Anything you'd want to see changed?

Seems OK to me, but there's already a bunch of bike-shedding in this
thread.

  reply	other threads:[~2016-12-06  7:52 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-29  9:23 Daniel Vetter
2016-11-29 10:28 ` Markus Heiser
2016-11-29 11:54   ` Mauro Carvalho Chehab
2016-11-29 10:38 ` Jani Nikula
2016-11-29 11:43   ` Mauro Carvalho Chehab
2016-11-29 15:08     ` Jani Nikula
2016-12-07 15:45       ` Daniel Vetter
2016-11-29 13:17 ` Daniel Vetter
2016-12-06  7:52   ` Peter Zijlstra [this message]
2016-12-07 15:45     ` Daniel Vetter
  -- strict thread matches above, loose matches on Subject: below --
2016-12-14 13:46 Daniel Vetter
2016-12-07 15:42 Daniel Vetter
2016-12-07 19:39 ` Jonathan Corbet
2016-12-08  9:10   ` Mauro Carvalho Chehab
2016-12-08 22:06     ` Daniel Vetter
2016-12-12 17:47       ` Mauro Carvalho Chehab
2016-12-12 17:54       ` Jonathan Corbet
2016-11-28 16:16 Daniel Vetter
2016-11-28 17:51 ` 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=20161206075241.GU3092@twins.programming.kicks-ass.net \
    --to=peterz@infradead.org \
    --cc=corbet@lwn.net \
    --cc=daniel.vetter@intel.com \
    --cc=hch@infradead.org \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@s-opensource.com \
    /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

Powered by JetHome