linux-kernel - Re: [PATCH v3 0/1] Compactly make code examples into literal blocks

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: <20200330163255.4322e763@lwn.net>
Date:   Mon, 30 Mar 2020 16:32:55 -0600
From:   Jonathan Corbet <corbet@....net>
To:     Peter Lister <peter@...eshed.quignogs.org.uk>
Cc:     Jani Nikula <jani.nikula@...ux.intel.com>,
        Matthew Wilcox <willy@...radead.org>,
        linux-kernel@...r.kernel.org,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael@...nel.org>, linux-doc@...r.kernel.org
Subject: Re: [PATCH v3 0/1] Compactly make code examples into literal blocks

On Mon, 30 Mar 2020 23:29:24 +0100
Peter Lister <peter@...eshed.quignogs.org.uk> wrote:

One quick thing caught my eye...

> One head-on approachis to literalise *all* kerneldoc comments for 
> functions and structures. The kerneldoc keywords then serve only to 
> generate links; the ReST output is minimal but guaranteed validand 
> warning free. Would any readers of API docs be inconvenienced? The 
> target readership are presumably programmers, and the searchability of 
> the sphinx RTD is more useful to me than the formatting.

The ability to put formatting directive into kerneldoc comments was one of
the driving forces that pushed the RST switch in the first place.  There
are subsystems that make use of this capability and would not be pleased
to see it go away.

jon