From: Jonathan Corbet <corbet@lwn.net>
To: Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk>
Cc: 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: Sat, 1 Aug 2015 13:22:10 +0200 [thread overview]
Message-ID: <20150801132210.2c0b84f1@lwn.net> (raw)
In-Reply-To: <1438376805-8964-1-git-send-email-danilo.cesar@collabora.co.uk>
On Fri, 31 Jul 2015 18:06:45 -0300
Danilo Cesar Lemes de Paula <danilo.cesar@collabora.co.uk> 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.
Thanks,
jon
next prev parent reply other threads:[~2015-08-01 11:22 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 [this message]
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
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=20150801132210.2c0b84f1@lwn.net \
--to=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=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.