lkml.org 
[lkml]   [2016]   [May]   [4]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: Kernel docs: muddying the waters a bit
On Wed, May 04, 2016 at 02:40:29PM +0200, Markus Heiser wrote:
> > On Wed, 04 May 2016, Markus Heiser <markus.heiser@darmarit.de> wrote:
> > I'd be *very* hesitant about adding the kind of things you do in
> > reformat_block_rst to kernel-doc. IMO the extraction from kernel-doc
> > comments must be as simple as possible with basically pass-through of
> > the comment blocks to sphinx.
>
> Right, but you forgot, that the current markup in the source code comments
> is based on the kernel-doc-nano-HOWTO and I guess no one will migrate all
> these source code comments to reST markup ;-)
>
> So there is a need to differentiate between *vintage* kernel-doc markup
> and reST markup.
>
> My suggestion is to add a tag to the comments, here a short example
> what this might look like.
>
> <vintage-comment-SNIP> --------------
> /**
> * drm_minor_release - Release DRM minor
> * @minor: Pointer to DRM minor object
> *
> * Release a minor that was previously acquired via drm_minor_acquire().
> */
> <vintage-comment-SNAP> --------------
>
> in short: the vintage style does not need any change and
> comments with reST markup has a tag ":reST:" in the first
> line(s) ...
>
> <reST-comment-SNIP> --------------
> /**
> * :reST:
> *
> * .. c:function:: void drm_minor_release(struct drm_minor *minor)
> *
> * Release DRM minor
> *
> * :param struct drm_minor \*minor: Pointer to DRM minor object
> *
> */
> <reST-comment-SNAP> --------------
>
> Comments with the ":reST:" tag could be exported and pass-through
> to sphinx.
>
> > Specifically, do not attempt to detect and
> > parse elements like lists in kernel-doc.
>
> If your markup in the comments is plain reST, no need to parse, but there
> are markups in the (vintage) comments which made use of individual
> text-markups, e.g. the markup of lists or ASCII-art.
>
> This individual text-markups has not been converted/rendered in the docbook
> output, but I wanted to convert this individuals to reST, to render them in
> Sphinx.

I think we need to unconfuse what's current standardize kerneldoc markup.
There's three bits:
- The header with the one-liner and parameters, i.e.

/**
* drm_minor_release - Release DRM minor
* @minor: Pointer to DRM minor object

There's thousands of those, and we cant realistically change them. This
means we need to teach kernel-doc to parse those and convert them to
rest/shpinx layout. Any approach that expects a conversion of all the
existing comments over to sphinx/rst is imo unworkable.

- References for function(), &structures, #constants and @parameters.
Again for the same reasons of being here already, we can't change those
at all. On top of that these markers are also used to generate
hyperlinks in the final docs. The kernel-doc script therefor not only
needs to generate the right markup, but also correct links. Without
generating links to functions/structures outside of a given document.

- kernel-doc also does paragraph splitting and minimalistic headers like

* Returns:
*
* This will be under a separate Returns: heading in the text.

afaict at least the paragraph splitting would be identical between all
proposed markup languages.

Now what all current proposals have done is simply allow pass-through of
asciidoc or rst markup in those paragraphs, so that the final processor
could make stuff pretty.

This is already used widely in kerneldoc included by gpu.tmpl, and
currently it's asciidoc. Those lists and asciiarts though are _not_
standard kerneldoc at all. But imo any doc toolchain improvement should
integrate along those lines.

For reference, this is what it's supposed to look like with the asciidoc
support enabled:

https://dri.freedesktop.org/docs/drm/API-struct-drm-display-mode.html

Fyi those hacked-up patches to make this happen are available in

https://cgit.freedesktop.org/drm-intel/log/?h=topic/kerneldoc

Note that this isn't upstream, but we did start using this support all
over in gpu documentation simply because we really, really need it. And
I'm willing to throw all the comments into a converter to end up with
whatever markup we decide upon.

But what will not work is to throw the existing kernel-doc standard into
the shredder. So all the stuff with @, (), & and # must keep working.

> E.g. compare the member & description section of struct drm-display-mode ...
>
> DocBook:
>
> * https://www.kernel.org/doc/htmldocs/gpu/API-struct-drm-display-mode.html
>
> kernel-doc reST with the additional reformat_block_rst function:
>
> * http://return42.github.io/sphkerneldoc/linux_src_doc/include/drm/drm_modes_h.html#struct-drm-display-mode

So we have this already. The two things I thought this entire discussion
was about:

- also throw out the docbook .xml and replace it with something else. That
was jani's prototype on top of asciidoc, and it sounds like we could do
something similar with rst/sphinx. Everyone pretty much agrees that
this would be a second step, and the first step would be to simply
integrate more advanced markup into the existing toolchain.

- which flavour of markup has the best support for more advanced use-cases
like those in the media docbook. It sounds like sphinx won that
competition.

I'd really like to converge on the markup question, so that we can start
using all the cool stuff with impunity in gpu documentations.
-Daniel
--
Daniel Vetter
Software Engineer, Intel Corporation
http://blog.ffwll.ch

\
 
 \ /
  Last update: 2016-05-04 16:01    [W:0.177 / U:4.052 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site