From: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
To: Jonathan Corbet <corbet@lwn.net>
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>
Subject: Re: [PATCH] scripts/kernel-doc Allow struct arguments documentation in struct body
Date: Sat, 01 Aug 2015 15:43:13 +0300 [thread overview]
Message-ID: <2476993.uXUxdrudJU@avalon> (raw)
In-Reply-To: <20150801132210.2c0b84f1@lwn.net>
Hi Jon,
On Saturday 01 August 2015 13:22:10 Jonathan Corbet wrote:
> On Fri, 31 Jul 2015 18:06:45 -0300 Danilo Cesar Lemes de Paula wrote:
> > Describing arguments at top of a struct definition works fine
> > for small/medium size structs, but it definitely doesn't work well
> > for struct with a huge list of elements.
> >
> > Keeping the arguments list inside the struct body makes it easier
> > to maintain the documentation.
>
> Interesting approach. I think it could make sense, but I fear pushback
> from a subset of maintainers refusing to accept this mode. I wonder what
> it would take to get a consensus on allowing these in-struct comments?
>
> 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.
The topic of documentation has been raised in the mail thread of the kernel
recruitment proposal for the kernel summit. I believe it's an important one,
and I will be very interested in contributing if it is discussed as a separate
topic.
--
Regards,
Laurent Pinchart
_______________________________________________
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: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
To: Jonathan Corbet <corbet@lwn.net>
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>,
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: Sat, 01 Aug 2015 15:43:13 +0300 [thread overview]
Message-ID: <2476993.uXUxdrudJU@avalon> (raw)
In-Reply-To: <20150801132210.2c0b84f1@lwn.net>
Hi Jon,
On Saturday 01 August 2015 13:22:10 Jonathan Corbet wrote:
> On Fri, 31 Jul 2015 18:06:45 -0300 Danilo Cesar Lemes de Paula wrote:
> > Describing arguments at top of a struct definition works fine
> > for small/medium size structs, but it definitely doesn't work well
> > for struct with a huge list of elements.
> >
> > Keeping the arguments list inside the struct body makes it easier
> > to maintain the documentation.
>
> Interesting approach. I think it could make sense, but I fear pushback
> from a subset of maintainers refusing to accept this mode. I wonder what
> it would take to get a consensus on allowing these in-struct comments?
>
> 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.
The topic of documentation has been raised in the mail thread of the kernel
recruitment proposal for the kernel summit. I believe it's an important one,
and I will be very interested in contributing if it is discussed as a separate
topic.
--
Regards,
Laurent Pinchart
next prev parent reply other threads:[~2015-08-01 12:43 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 [this message]
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
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=2476993.uXUxdrudJU@avalon \
--to=laurent.pinchart@ideasonboard.com \
--cc=corbet@lwn.net \
--cc=daniel.vetter@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=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.