linux-kernel - Re: [PATCH 2/2] doc: cgroup: highlight all paths using the :file: inline markup

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 for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20190102090948.1500a4a8@lwn.net>
Date:   Wed, 2 Jan 2019 09:09:48 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Tejun Heo <tj@...nel.org>
Cc:     Otto Sabart <ottosabart@...erm.com>, linux-doc@...r.kernel.org,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH 2/2] doc: cgroup: highlight all paths using the :file:
 inline markup

On Wed, 2 Jan 2019 08:01:49 -0800
Tejun Heo <tj@...nel.org> wrote:

> On Sun, Dec 30, 2018 at 05:50:44PM +0100, Otto Sabart wrote:
> > Improve readability using the :file: markup.  
> 
> Heh, that's a minor plus for formatted output and minor minus for the
> source.  If this is a convention generally followed for
> documentations, I have no objects.  That said, can you please reflow
> the lines?

The convention is to minimize markup, especially in cases where it's not
really needed and it impairs the readability of the plain-text file.  My
feeling is that this particular markup doesn't provide enough benefit to
be worth the cost.  

Otto, we all very much appreciate attempts to improve the documentation,
and I hope you won't stop.  If you would like to do RST work, one very
helpful thing would be to look into the conversion of the (many) remaining
plain-text documents and integration into the doc tree.

Thanks,

jon