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

Groups > linux.kernel > #1198898

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

Show all headers | View raw

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

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

Thread

Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Jonathan Corbet <corbet@lwn.net> - 2015-08-01 13:30 +0200
  Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Daniel Vetter <daniel@ffwll.ch> - 2015-08-03 10:30 +0200
    Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Jonathan Corbet <corbet@lwn.net> - 2015-08-03 16:40 +0200
      Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation  in struct body Daniel Vetter <daniel@ffwll.ch> - 2015-08-03 17:40 +0200

csiph-web