From: sashiko-bot@kernel.org
To: "Babanpreet Singh" <bbnpreetsingh@gmail.com>
Cc: linux-hwmon@vger.kernel.org
Subject: Re: [PATCH] hwmon: (peci) Fix kernel-doc parameter names in common.h
Date: Sun, 12 Jul 2026 08:14:11 +0000 [thread overview]
Message-ID: <20260712081412.20EC81F000E9@smtp.kernel.org> (raw)
In-Reply-To: <20260712081258.7-1-bbnpreetsingh@gmail.com>
> scripts/kernel-doc -Wall -none reports:
>
> Warning: drivers/hwmon/peci/common.h:39 function parameter 'state' not
> described in 'peci_sensor_need_update'
> Warning: drivers/hwmon/peci/common.h:39 Excess function parameter
> 'sensor' description in 'peci_sensor_need_update'
> Warning: drivers/hwmon/peci/common.h:49 function parameter 'state' not
> described in 'peci_sensor_mark_updated'
> Warning: drivers/hwmon/peci/common.h:49 Excess function parameter
> 'sensor' description in 'peci_sensor_mark_updated'
>
> Both peci_sensor_need_update() and peci_sensor_mark_updated() take a
> pointer to struct peci_sensor_state named 'state', but their kernel-doc
> comments document a parameter named 'sensor' and describe it as a
> pointer to the sensor data struct. The comments have been out of sync
> with the code since the file was added by commit bf3608f338e9 ("hwmon:
> peci: Add cputemp driver").
>
> Update the kernel-doc comments to document the 'state' parameter.
>
> No functional change.
>
> Assisted-by: Claude:claude-sonnet-5
> Signed-off-by: Babanpreet Singh <bbnpreetsingh@gmail.com>
Sashiko has reviewed this patch and found no issues. It looks great!
--
Sashiko AI review · https://sashiko.dev/#/patchset/20260712081258.7-1-bbnpreetsingh@gmail.com?part=1
prev parent reply other threads:[~2026-07-12 8:14 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-12 8:12 [PATCH] hwmon: (peci) Fix kernel-doc parameter names in common.h Babanpreet Singh
2026-07-12 8:14 ` sashiko-bot [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=20260712081412.20EC81F000E9@smtp.kernel.org \
--to=sashiko-bot@kernel.org \
--cc=bbnpreetsingh@gmail.com \
--cc=linux-hwmon@vger.kernel.org \
--cc=sashiko-reviews@lists.linux.dev \
/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