From: Jonathan Corbet <corbet@lwn.net>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: Michal Marek <mmarek@suse.cz>,
Herbert Xu <herbert@gondor.apana.org.au>,
Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk>,
linux-doc@vger.kernel.org, Stephan Mueller <smueller@chronox.de>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
intel-gfx <intel-gfx@lists.freedesktop.org>,
Randy Dunlap <rdunlap@infradead.org>,
linux-kernel@vger.kernel.org,
dri-devel <dri-devel@lists.freedesktop.org>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>
Subject: Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body
Date: Mon, 3 Aug 2015 08:37:41 -0600 [thread overview]
Message-ID: <20150803083741.04bfb6ed@lwn.net> (raw)
In-Reply-To: <20150803082319.GB24689@phenom.ffwll.local>
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
_______________________________________________
dri-devel mailing list
dri-devel@lists.freedesktop.org
http://lists.freedesktop.org/mailman/listinfo/dri-devel
WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Corbet <corbet@lwn.net>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk>,
linux-doc@vger.kernel.org, Randy Dunlap <rdunlap@infradead.org>,
Daniel Vetter <daniel.vetter@ffwll.ch>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
Herbert Xu <herbert@gondor.apana.org.au>,
Stephan Mueller <smueller@chronox.de>,
Michal Marek <mmarek@suse.cz>,
linux-kernel@vger.kernel.org,
intel-gfx <intel-gfx@lists.freedesktop.org>,
dri-devel <dri-devel@lists.freedesktop.org>
Subject: Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body
Date: Mon, 3 Aug 2015 08:37:41 -0600 [thread overview]
Message-ID: <20150803083741.04bfb6ed@lwn.net> (raw)
In-Reply-To: <20150803082319.GB24689@phenom.ffwll.local>
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
next prev parent reply other threads:[~2015-08-03 14:37 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-07-31 21:06 [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body Danilo Cesar Lemes de Paula
2015-07-31 21:06 ` Danilo Cesar Lemes de Paula
2015-08-01 11:22 ` Jonathan Corbet
2015-08-01 12:43 ` Laurent Pinchart
2015-08-01 12:43 ` Laurent Pinchart
2015-08-03 8:23 ` Daniel Vetter
2015-08-03 8:23 ` Daniel Vetter
2015-08-03 14:37 ` Jonathan Corbet [this message]
2015-08-03 14:37 ` Jonathan Corbet
2015-08-03 15:33 ` Daniel Vetter
2015-08-03 15:59 ` Randy Dunlap
2015-08-03 16:29 ` Danilo Cesar Lemes de Paula
2015-08-04 9:04 ` Daniel Vetter
2015-08-04 9:04 ` Daniel Vetter
2015-08-04 12:04 ` [PATCH v2] " Danilo Cesar Lemes de Paula
2015-08-04 12:04 ` Danilo Cesar Lemes de Paula
2015-08-06 19:13 ` Jonathan Corbet
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20150803083741.04bfb6ed@lwn.net \
--to=corbet@lwn.net \
--cc=daniel.vetter@ffwll.ch \
--cc=daniel@ffwll.ch \
--cc=danilo.cesar@collabora.co.uk \
--cc=dri-devel@lists.freedesktop.org \
--cc=herbert@gondor.apana.org.au \
--cc=intel-gfx@lists.freedesktop.org \
--cc=laurent.pinchart@ideasonboard.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mmarek@suse.cz \
--cc=rdunlap@infradead.org \
--cc=smueller@chronox.de \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.