From: Andy Shevchenko <andy@kernel.org>
To: Bartosz Golaszewski <brgl@bgdev.pl>
Cc: Kent Gibson <warthog618@gmail.com>,
linux-kernel@vger.kernel.org, linux-gpio@vger.kernel.org,
linus.walleij@linaro.org
Subject: Re: [PATCH 1/4] gpiolib: cdev: relocate debounce_period_us from struct gpio_desc
Date: Thu, 14 Dec 2023 16:35:09 +0200 [thread overview]
Message-ID: <ZXsSnTcnAsopYodl@smile.fi.intel.com> (raw)
In-Reply-To: <CAMRc=MeZg0xg7ASA3x4PxCYymCmCEp0zZbUgGTCCzrjPaPZCag@mail.gmail.com>
On Thu, Dec 14, 2023 at 10:40:26AM +0100, Bartosz Golaszewski wrote:
> On Thu, Dec 14, 2023 at 3:15 AM Kent Gibson <warthog618@gmail.com> wrote:
> > On Thu, Dec 14, 2023 at 08:18:01AM +0800, Kent Gibson wrote:
> > > On Wed, Dec 13, 2023 at 10:07:12PM +0200, Andy Shevchenko wrote:
> > > > On Wed, Dec 13, 2023 at 08:03:44PM +0100, Bartosz Golaszewski wrote:
...
> > > > > > - it adds complications for no benefit
> > >
> > > It provides a placeholder for collective documentation and clarifies
> > > scope for the reader.
> >
> > Turns out kernel-doc can't deal with a struct variable declaration - it
> > needs the struct to be named.
> >
> > So this doesn't parse:
> >
> > static struct {
> > struct rb_root tree;
> > spinlock_t lock;
> > } supinfo;
> >
> > but this does:
> >
> > static struct supinfo {
> > struct rb_root tree;
> > spinlock_t lock;
> > } supinfo;
> >
> > at which point I prefer the separate struct and var declarations as per
> > the patch.
> >
> > Opinions?
>
> Yeah, don't make it a kernel doc. It's a private structure, no need to
> expose documentation for it in docs. Just use a regular comment - say
> what it is and why it's here.
I agree with Bart, make it plain comment if needed.
--
With Best Regards,
Andy Shevchenko
next prev parent reply other threads:[~2023-12-14 14:35 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-12-12 5:42 [PATCH 0/4] gpiolib: cdev: relocate debounce_period_us Kent Gibson
2023-12-12 5:42 ` [PATCH 1/4] gpiolib: cdev: relocate debounce_period_us from struct gpio_desc Kent Gibson
2023-12-13 13:54 ` Andy Shevchenko
2023-12-13 14:27 ` Kent Gibson
2023-12-13 15:40 ` Bartosz Golaszewski
2023-12-13 15:59 ` Kent Gibson
2023-12-13 16:12 ` Andy Shevchenko
2023-12-13 16:15 ` Bartosz Golaszewski
2023-12-13 16:29 ` Andy Shevchenko
2023-12-13 19:03 ` Bartosz Golaszewski
2023-12-13 20:07 ` Andy Shevchenko
2023-12-14 0:18 ` Kent Gibson
2023-12-14 2:15 ` Kent Gibson
2023-12-14 9:40 ` Bartosz Golaszewski
2023-12-14 14:35 ` Andy Shevchenko [this message]
2023-12-14 14:47 ` Kent Gibson
2023-12-13 16:14 ` Bartosz Golaszewski
2023-12-13 16:15 ` Kent Gibson
2023-12-13 16:16 ` Bartosz Golaszewski
2023-12-13 16:27 ` Andy Shevchenko
2023-12-12 5:42 ` [PATCH 2/4] gpiolib: remove " Kent Gibson
2023-12-12 5:42 ` [PATCH 3/4] gpiolib: cdev: reduce locking in gpio_desc_to_lineinfo() Kent Gibson
2023-12-13 13:56 ` Andy Shevchenko
2023-12-13 14:07 ` Kent Gibson
2023-12-13 15:05 ` Andy Shevchenko
2023-12-13 15:11 ` Kent Gibson
2023-12-13 15:28 ` Andy Shevchenko
2023-12-12 5:42 ` [PATCH 4/4] gpiolib: cdev: improve documentation of get/set values Kent Gibson
2023-12-12 17:09 ` [PATCH 0/4] gpiolib: cdev: relocate debounce_period_us Bartosz Golaszewski
2023-12-12 23:58 ` Kent Gibson
2023-12-13 10:03 ` Bartosz Golaszewski
2023-12-13 13:17 ` Kent Gibson
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=ZXsSnTcnAsopYodl@smile.fi.intel.com \
--to=andy@kernel.org \
--cc=brgl@bgdev.pl \
--cc=linus.walleij@linaro.org \
--cc=linux-gpio@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=warthog618@gmail.com \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).