linux-kernel - Re: [PATCH] doc: Explain light-handed markup preference a bit better

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: <20161206075241.GU3092@twins.programming.kicks-ass.net>
Date:   Tue, 6 Dec 2016 08:52:41 +0100
From:   Peter Zijlstra <peterz@...radead.org>
To:     LKML <linux-kernel@...r.kernel.org>,
        Jonathan Corbet <corbet@....net>, linux-doc@...r.kernel.org,
        Christoph Hellwig <hch@...radead.org>,
        Jani Nikula <jani.nikula@...ux.intel.com>,
        Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Daniel Vetter <daniel.vetter@...el.com>
Subject: Re: [PATCH] doc: Explain light-handed markup preference a bit better

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@....net>
> > Cc: linux-doc@...r.kernel.org
> > Cc: Christoph Hellwig <hch@...radead.org>
> > Cc: Peter Zijlstra <peterz@...radead.org>
> > Cc: Jani Nikula <jani.nikula@...ux.intel.com>
> > Cc: Mauro Carvalho Chehab <mchehab@...pensource.com>
> > Signed-off-by: Daniel Vetter <daniel.vetter@...el.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.