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

Groups > linux.kernel > #1413454

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

Show all headers | View raw

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

Back to linux.kernel | Previous | Next — Next in thread | Find similar | Unroll thread

Thread

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

csiph-web