Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1413454 > unrolled thread

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

Back to article view | Back to linux.kernel

This discussion starts older than the indexed window; earlier articles aren't shown. The article labeled Started by below is the oldest one visible, not the original post.

Contents

  Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc  directive extension Jonathan Corbet <corbet@lwn.net> - 2016-06-03 22:40 +0200
    Re: [PATCH 05/10] Documentation/sphinx: add Sphinx kernel-doc directive extension Markus Heiser <markus.heiser@darmarit.de> - 2016-06-04 09:00 +0200

#1413454 — 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@intel.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

[toc] | [next] | [standalone]

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

Am 03.06.2016 um 22:35 schrieb Jonathan Corbet <corbet@lwn.net>:

> On Fri, 20 May 2016 16:39:36 +0300
> Jani Nikula <jani.nikula@intel.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.

IMO it is better to be explicit ... wildcards (ranges) has the disadvantage that
you can't check if any/all definition is missed ...

--Markus-- 

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

[toc] | [prev] | [standalone]

Back to top | Article view | linux.kernel

csiph-web