linux-kernel - Re: [PATCH v2 08/29] docs: filesystems: convert configfs.txt to ReST

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: <894438a6-cd91-1728-a313-4bf4f8d5074d@bikeshed.quignogs.org.uk>
Date:   Fri, 24 Apr 2020 18:28:54 +0100
From:   Peter Lister <peter@...eshed.quignogs.org.uk>
To:     Christoph Hellwig <hch@....de>,
        Matthew Wilcox <willy@...radead.org>
Cc:     Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        Joel Becker <jlbec@...lplan.org>, linux-usb@...r.kernel.org
Subject: Re: [PATCH v2 08/29] docs: filesystems: convert configfs.txt to ReST

On 21/04/2020 18:23, Christoph Hellwig wrote:
> It wasn't entirely uncommon, but that's not really the point.  The
> Problem is all the weird ".." or "::" annotations that really kill
> the flow, or things like "|copy|" that have no reason to exist.

You aren't supposed to read REST documentation files - as opposed to 
kerneldoc comments in the C source - any more than you read HTML.

[ Exactly what should or should not be in C source kerneldoc is another 
matter. ]

Developers are used to reading plain ol' text files for quick reference. 
But there is no make target to generate the text files.

Can we create a method to build text *output* files?