linux-kernel - Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension

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: <20160603143536.194ff752@lwn.net>
Date:	Fri, 3 Jun 2016 14:35:36 -0600
From:	Jonathan Corbet <corbet@....net>
To:	Jani Nikula <jani.nikula@...el.com>
Cc:	Markus Heiser <markus.heiser@...marit.de>,
	Daniel Vetter <daniel.vetter@...ll.ch>,
	Grant Likely <grant.likely@...retlab.ca>,
	Mauro Carvalho Chehab <mchehab@....samsung.com>,
	Dan Allen <dan@...ndevise.io>,
	Russel Winder <russel@...der.org.uk>,
	Keith Packard <keithp@...thp.com>,
	LKML <linux-kernel@...r.kernel.org>, linux-doc@...r.kernel.org,
	Hans Verkuil <hverkuil@...all.nl>
Subject: Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc
 directive extension

On Fri, 20 May 2016 16:39:36 +0300
Jani Nikula <jani.nikula@...el.com> wrote:

> Add an extension to handle kernel-doc directives, to call kernel-doc
> according to the arguments and parameters given to the reStructuredText
> directive.
> 
> The syntax for the kernel-doc directive is:
> 
> .. kernel-doc:: FILENAME
>    :export:
>    :internal:
>    :functions: FUNCTION [FUNCTION ...]
>    :doc: SECTION TITLE

So this seems just like what the doctor ordered - nice!

One little thought that has crossed my mind: it might be nice to be able to
put a regex in :functions: so we could say something like:

    :functions: atomic_.*

That requires a kernel-doc tweak too, of course.  Someday.

Might it be worth running this by the Sphinx list just to see what they
have to say?

jon