From: Mika Westerberg <mika.westerberg@linux.intel.com>
To: Lee Jones <lee.jones@linaro.org>
Cc: Andy Shevchenko <andy.shevchenko@gmail.com>,
"linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
Andreas Noever <andreas.noever@gmail.com>,
Michael Jamet <michael.jamet@intel.com>,
Yehezkel Bernat <YehezkelShB@gmail.com>,
"linux-usb@vger.kernel.org" <linux-usb@vger.kernel.org>
Subject: Re: [PATCH 05/12] thunderbolt: pa: Demote non-conformant kernel-doc headers
Date: Wed, 27 Jan 2021 19:00:35 +0200 [thread overview]
Message-ID: <20210127170035.GG2542@lahna.fi.intel.com> (raw)
In-Reply-To: <20210127161320.GK4903@dell>
On Wed, Jan 27, 2021 at 04:13:20PM +0000, Lee Jones wrote:
> On Wed, 27 Jan 2021, Andy Shevchenko wrote:
>
> > On Wednesday, January 27, 2021, Lee Jones <lee.jones@linaro.org> wrote:
> >
> > > Fixes the following W=1 kernel build warning(s):
> > >
> > > drivers/thunderbolt/path.c:476: warning: Function parameter or member
> > > 'path' not described in 'tb_path_activate'
> > > drivers/thunderbolt/path.c:568: warning: Function parameter or member
> > > 'path' not described in 'tb_path_is_invalid'
> > >
> > >
> > I think the intention was to describe them in kernel doc format, perhaps
> > you need to add descriptions of the fields?
>
> For changes like this, I've been working to the following rule:
>
> - I'll provide fix-ups; if and only if the author has had a
> reasonable attempt at providing a conformant kernel-doc header.
>
> So if the headers are just suffering from a little doc-rot i.e. the
> API has changed, but the doc update was omitted, or most of the
> parameters/members are documented, but some were forgotten about etc,
> or if there are formatting issues, I'll happily take up the slack and
> polish those up a bit.
>
> However, if no attempt was made, then they get demoted.
>
> I don't want to get into a situation where authors delicately provide
> weak documentation with the expectation that someone else will come
> along and turn them into conformant docs.
>
> If authors wish to come back, provide proper descriptions &
> formatting and subsequently re-promote them again, then all power to
> them.
Thanks for pointing these out. I prefer we fix the kernel-docs (add what
is missing) instead. I'll take care of that.
next prev parent reply other threads:[~2021-01-27 17:05 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-01-27 11:25 [PATCH 00/12] Rid W=1 warnings from Thunderbolt Lee Jones
2021-01-27 11:25 ` [PATCH 01/12] thunderbolt: dma_port: Remove unused variable 'ret' Lee Jones
[not found] ` <CAHp75VdnvG75bTZ9Zqpn=pm0_KNwK0GGBGGjZv1DpSY-6Ef_Xw@mail.gmail.com>
2021-01-27 16:19 ` Lee Jones
2021-01-27 16:57 ` Mika Westerberg
2021-01-28 8:52 ` [PATCH V2 01/12] thunderbolt: dma_port: Check 'dma_port_flash_write_block()'s return value Lee Jones
2021-01-28 11:01 ` Mika Westerberg
2021-01-27 11:25 ` [PATCH 02/12] thunderbolt: cap: Fix kernel-doc formatting issue Lee Jones
2021-01-27 11:25 ` [PATCH 03/12] thunderbolt: ctl: Demote non-conformant kernel-doc headers Lee Jones
2021-01-27 11:25 ` [PATCH 04/12] thunderbolt: eeprom: Demote non-conformant kernel-doc headers to standard comment blocks Lee Jones
2021-01-27 11:25 ` [PATCH 05/12] thunderbolt: pa: Demote non-conformant kernel-doc headers Lee Jones
[not found] ` <CAHp75VcFSQqDqjKCiCxdWyRpDDeMo4H6ELMHX15JSPfpt7nGHQ@mail.gmail.com>
2021-01-27 16:13 ` Lee Jones
2021-01-27 17:00 ` Mika Westerberg [this message]
2021-01-28 8:23 ` Lee Jones
2021-01-28 8:27 ` Mika Westerberg
2021-01-28 8:38 ` Lee Jones
2021-01-27 11:25 ` [PATCH 06/12] thunderbolt: xdomain: Fix 'tb_unregister_service_driver()'s 'drv' param Lee Jones
2021-01-27 11:25 ` [PATCH 07/12] thunderbolt: nhi: Demote some non-conformant kernel-doc headers Lee Jones
2021-01-27 11:25 ` [PATCH 08/12] thunderbolt: tb: Kernel-doc function headers should document their parameters Lee Jones
2021-01-27 11:25 ` [PATCH 09/12] thunderbolt: swit: Demote a bunch of non-conformant kernel-doc headers Lee Jones
2021-01-27 11:25 ` [PATCH 10/12] thunderbolt: icm: Fix a couple of formatting issues Lee Jones
2021-01-27 11:25 ` [PATCH 11/12] thunderbolt: tunnel: Fix misspelling of 'receive_path' Lee Jones
2021-01-27 11:25 ` [PATCH 12/12] thunderbolt: swit: Fix function name in the header Lee Jones
2021-01-28 11:09 ` [PATCH 00/12] Rid W=1 warnings from Thunderbolt Mika Westerberg
2021-01-28 13:16 ` Lee Jones
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=20210127170035.GG2542@lahna.fi.intel.com \
--to=mika.westerberg@linux.intel.com \
--cc=YehezkelShB@gmail.com \
--cc=andreas.noever@gmail.com \
--cc=andy.shevchenko@gmail.com \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-usb@vger.kernel.org \
--cc=michael.jamet@intel.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).