From: Lee Jones <lee.jones@linaro.org>
To: Wolfram Sang <wsa@kernel.org>,
linux-kernel@vger.kernel.org,
Krzysztof Adamski <krzysztof.adamski@nokia.com>,
Anders Berg <anders.berg@lsi.com>,
linux-i2c@vger.kernel.org
Subject: Re: [PATCH 05/16] i2c: busses: i2c-axxia: Fix formatting issue in struct and demote unworthy kernel-doc headers
Date: Fri, 4 Jun 2021 09:49:58 +0100 [thread overview]
Message-ID: <20210604084958.GH2435141@dell> (raw)
In-Reply-To: <YLk7P3+vcR1hNpBO@kunai>
On Thu, 03 Jun 2021, Wolfram Sang wrote:
>
> > -/**
> > - * axxia_i2c_dev - I2C device context
> > +/*
> > + * struct axxia_i2c_dev - I2C device context
> > * @base: pointer to register struct
> > * @msg: pointer to current message
> > * @msg_r: pointer to current read message (sequence transfer)
>
> Shouldn't we keep the kernel-doc header here?
There are a couple of missing descriptions still, but a) since a
concerted effort seems to have been made with this and b) the
remaining descriptions look fairly generic/trivial, I'd be prepared to
re-work this patch.
Will fix.
--
Lee Jones [李琼斯]
Senior Technical Lead - Developer Services
Linaro.org │ Open source software for Arm SoCs
Follow Linaro: Facebook | Twitter | Blog
next prev parent reply other threads:[~2021-06-04 8:50 UTC|newest]
Thread overview: 52+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-20 19:00 [PATCH 00/16] Rid W=1 warnings from I2C Lee Jones
2021-05-20 19:00 ` [PATCH 01/16] i2c: busses: i2c-nomadik: Fix formatting issue pertaining to 'timeout' Lee Jones
2021-05-27 0:21 ` Linus Walleij
2021-05-27 19:28 ` Wolfram Sang
2021-05-28 7:58 ` Lee Jones
2021-05-28 8:00 ` Wolfram Sang
2021-05-28 8:17 ` Lee Jones
2021-05-20 19:00 ` [PATCH 02/16] i2c: muxes: i2c-arb-gpio-challenge: Demote non-conformant kernel-doc headers Lee Jones
2021-05-20 19:33 ` Doug Anderson
2021-05-21 6:32 ` Peter Rosin
2021-05-27 19:30 ` Wolfram Sang
2021-05-20 19:00 ` [PATCH 03/16] i2c: busses: i2c-ali1563: File headers are not good candidates for kernel-doc Lee Jones
2021-05-21 10:06 ` Jean Delvare
2021-05-27 19:30 ` Wolfram Sang
2021-05-20 19:00 ` [PATCH 04/16] i2c: busses: i2c-altera: Fix formatting issue in struct and demote unworthy kernel-doc headers Lee Jones
2021-06-03 20:25 ` Wolfram Sang
2021-05-20 19:00 ` [PATCH 05/16] i2c: busses: i2c-axxia: " Lee Jones
2021-06-03 20:27 ` Wolfram Sang
2021-06-04 8:49 ` Lee Jones [this message]
2021-05-20 19:00 ` [PATCH 06/16] i2c: busses: i2c-cadence: Fix incorrectly documented 'enum cdns_i2c_slave_mode' Lee Jones
2021-05-24 6:49 ` Michal Simek
2021-05-20 19:00 ` [PATCH 07/16] i2c: busses: i2c-designware-master: Fix misnaming of 'i2c_dw_init_master()' Lee Jones
2021-05-21 7:03 ` Jarkko Nikula
2021-05-20 19:00 ` [PATCH 08/16] i2c: busses: i2c-eg20t: Fix 'bad line' issue and provide description for 'msgs' param Lee Jones
2021-05-27 19:33 ` Wolfram Sang
2021-05-20 19:00 ` [PATCH 09/16] i2c: busses: i2c-mxs: Demote barely half complete kernel-doc header Lee Jones
2021-06-03 20:29 ` Wolfram Sang
2021-06-04 8:47 ` Lee Jones
2021-06-04 9:06 ` Wolfram Sang
2021-06-04 9:32 ` Lee Jones
2021-05-20 19:00 ` [PATCH 10/16] i2c: busses: i2c-ocores: Place the expected function names into the documentation headers Lee Jones
2021-05-20 19:12 ` Andrew Lunn
2021-05-20 20:21 ` Peter Korsgaard
2021-05-27 19:33 ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 11/16] i2c: busses: i2c-pnx: Provide descriptions for 'alg_data' data structure Lee Jones
2021-05-21 6:24 ` Vladimir Zapolskiy
2021-05-20 19:01 ` [PATCH 12/16] i2c: busses: i2c-rk3x: Demote unworthy headers and help more complete ones Lee Jones
2021-05-20 21:52 ` Heiko Stübner
2021-05-21 6:56 ` Lee Jones
2021-06-19 22:07 ` Heiko Stuebner
2021-05-20 19:01 ` [PATCH 13/16] i2c: busses: i2c-st: Fix copy/paste function misnaming issues Lee Jones
2021-05-21 14:17 ` Alain Volmat
2021-05-21 14:23 ` Alain Volmat
2021-05-27 19:35 ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 14/16] i2c: busses: i2c-stm32f4: Remove incorrectly placed ' ' from function name Lee Jones
2021-05-21 14:20 ` Alain Volmat
2021-05-27 19:35 ` Wolfram Sang
2021-05-20 19:01 ` [PATCH 15/16] i2c: busses: i2c-tegra-bpmp: Demote kernel-doc abuses Lee Jones
2021-06-01 15:04 ` Thierry Reding
2021-05-20 19:01 ` [PATCH 16/16] i2c: busses: i2c-st: trivial: Fix spelling issue 'enmpty => empty' Lee Jones
2021-05-21 14:23 ` Alain Volmat
2021-05-27 19:38 ` Wolfram Sang
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=20210604084958.GH2435141@dell \
--to=lee.jones@linaro.org \
--cc=anders.berg@lsi.com \
--cc=krzysztof.adamski@nokia.com \
--cc=linux-i2c@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=wsa@kernel.org \
/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).