Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body

Jonathan Corbet
2015-08-03T14:37:48Z

On Mon, 3 Aug 2015 10:23:19 +0200
Daniel Vetter <daniel@ffwll.ch> wrote:

> > I'm wondering if we need a kernel summit session on commenting
> > conventions, markdown-in-kerneldoc, etc? Maybe I'll stick a proposal out
> > there.
>
> Might be useful, but I'm not sure how many people really would actively
> work on improving the tooling. The only comment I've seen is to maybe use
> gtkdoc, but that would be a pain since it's slightly incompatible with
> kerneldoc.

The idea was to get a sense for what sort of improvements would be
useful, to begin with. But my attempt to start a discussion on the
kernel summit list appears to have hit the ground pretty hard; I guess
that means I have free rein :)

I expect I'll apply the struct-args doc patch in the fairly near future.
Then we'll see if others complain when patches using it start to show up,
but the feature itself shouldn't break anything. I'm *really* hoping to
take a hard look at Danilo's stuff for a 4.3 merge as well. It should be
possible, but there's real-world obnoxiousness that is doing its best to
get in the way.

jon