From: Nishanth Menon <nm@ti.com>
To: Randy Dunlap <rdunlap@infradead.org>
Cc: <linux-kernel@vger.kernel.org>,
Sebastian Reichel <sre@kernel.org>, <linux-pm@vger.kernel.org>
Subject: Re: [PATCH v2] PM: SmartReflex: fix kernel-doc warnings in smartreflex.h
Date: Thu, 3 Sep 2026 08:58:14 -0500 [thread overview]
Message-ID: <20260903135814.3m3mdu2voaacfk7c@hatless> (raw)
In-Reply-To: <20260831055059.3456532-1-rdunlap@infradead.org>
On 22:50-20260830, Randy Dunlap wrote:
> Use the correct function name in a kernel-doc comment and
> use the correct kernel-doc format for struct members to avoid
> kernel-doc warnings:
>
> Warning: include/linux/power/smartreflex.h:187 expecting prototype for
> test_cond_timeout(). Prototype was for sr_test_cond_timeout() instead
> Warning: include/linux/power/smartreflex.h:292 struct member 'err_weight'
> not described in 'omap_sr_data'
> Warning: include/linux/power/smartreflex.h:292 struct member
> 'err_maxlimit' not described in 'omap_sr_data'
> Warning: include/linux/power/smartreflex.h:292 struct member 'accum_data'
> not described in 'omap_sr_data'
> Warning: include/linux/power/smartreflex.h:292 struct member
> 'senn_avgweight' not described in 'omap_sr_data'
> Warning: include/linux/power/smartreflex.h:292 struct member
> 'senp_avgweight' not described in 'omap_sr_data'
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> v2: rebase & resend
>
> Cc: Nishanth Menon <nm@ti.com>
> Cc: Sebastian Reichel <sre@kernel.org>
> Cc: linux-pm@vger.kernel.org
>
> include/linux/power/smartreflex.h | 12 ++++++------
> 1 file changed, 6 insertions(+), 6 deletions(-)
>
> --- linux-next-20260828.orig/include/linux/power/smartreflex.h
> +++ linux-next-20260828/include/linux/power/smartreflex.h
> @@ -174,7 +174,7 @@ struct omap_sr {
> };
>
> /**
> - * test_cond_timeout - busy-loop, testing a condition
> + * sr_test_cond_timeout - busy-loop, testing a condition
> * @cond: condition to test until it evaluates to true
> * @timeout: maximum number of microseconds in the timeout
> * @index: loop index (integer)
> @@ -267,11 +267,11 @@ struct omap_sr_nvalue_table {
> * @ip_type: Smartreflex IP type.
> * @senp_mod: SENPENABLE value of the sr CONFIG register
> * @senn_mod: SENNENABLE value for sr CONFIG register
> - * @err_weight ERRWEIGHT value of the sr ERRCONFIG register
> - * @err_maxlimit ERRMAXLIMIT value of the sr ERRCONFIG register
> - * @accum_data ACCUMDATA value of the sr CONFIG register
> - * @senn_avgweight SENNAVGWEIGHT value of the sr AVGWEIGHT register
> - * @senp_avgweight SENPAVGWEIGHT value of the sr AVGWEIGHT register
> + * @err_weight: ERRWEIGHT value of the sr ERRCONFIG register
> + * @err_maxlimit: ERRMAXLIMIT value of the sr ERRCONFIG register
> + * @accum_data: ACCUMDATA value of the sr CONFIG register
> + * @senn_avgweight: SENNAVGWEIGHT value of the sr AVGWEIGHT register
> + * @senp_avgweight: SENPAVGWEIGHT value of the sr AVGWEIGHT register
> * @nvalue_count: Number of distinct nvalues in the nvalue table
> * @nvalue_table: table containing the efuse offsets and nvalues
> * corresponding to them.
Reviewed-by: Nishanth Menon <nm@ti.com>
--
Regards,
Nishanth Menon
Key (0xDDB5849D1736249D) / Fingerprint: F8A2 8693 54EB 8232 17A3 1A34 DDB5 849D 1736 249D
https://ti.com/opensource
prev parent reply other threads:[~2026-09-03 13:59 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-08-31 5:50 [PATCH v2] PM: SmartReflex: fix kernel-doc warnings in smartreflex.h Randy Dunlap
2026-09-03 13:58 ` Nishanth Menon [this message]
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=20260903135814.3m3mdu2voaacfk7c@hatless \
--to=nm@ti.com \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-pm@vger.kernel.org \
--cc=rdunlap@infradead.org \
--cc=sre@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