Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension
From: Markus Heiser
Date: Sat Jun 04 2016 - 02:58:31 EST
Am 03.06.2016 um 22:35 schrieb Jonathan Corbet <corbet@xxxxxxx>:
> On Fri, 20 May 2016 16:39:36 +0300
> Jani Nikula <jani.nikula@xxxxxxxxx> wrote:
>> Add an extension to handle kernel-doc directives, to call kernel-doc
>> according to the arguments and parameters given to the reStructuredText
>> The syntax for the kernel-doc directive is:
>> .. kernel-doc:: FILENAME
>> :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.
IMO it is better to be explicit ... wildcards (ranges) has the disadvantage that
you can't check if any/all definition is missed ...
> Might it be worth running this by the Sphinx list just to see what they
> have to say?