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

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



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
> 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
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux