From: Babanpreet Singh <bbnpreetsingh@gmail.com>
To: Iwona Winiarska <iwona.winiarska@intel.com>,
Guenter Roeck <linux@roeck-us.net>
Cc: linux-hwmon@vger.kernel.org, linux-kernel@vger.kernel.org,
Babanpreet Singh <bbnpreetsingh@gmail.com>
Subject: [PATCH] hwmon: (peci) Fix kernel-doc parameter names in common.h
Date: Sun, 12 Jul 2026 08:12:58 +0000 [thread overview]
Message-ID: <20260712081258.7-1-bbnpreetsingh@gmail.com> (raw)
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>
---
drivers/hwmon/peci/common.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/drivers/hwmon/peci/common.h b/drivers/hwmon/peci/common.h
index 92a7ee1925bc..5eae9681e385 100644
--- a/drivers/hwmon/peci/common.h
+++ b/drivers/hwmon/peci/common.h
@@ -31,7 +31,7 @@ struct peci_sensor_data {
/**
* peci_sensor_need_update() - check whether sensor update is needed or not
- * @sensor: pointer to sensor data struct
+ * @state: pointer to sensor state struct
*
* Return: true if update is needed, false if not.
*/
@@ -44,7 +44,7 @@ static inline bool peci_sensor_need_update(struct peci_sensor_state *state)
/**
* peci_sensor_mark_updated() - mark the sensor is updated
- * @sensor: pointer to sensor data struct
+ * @state: pointer to sensor state struct
*/
static inline void peci_sensor_mark_updated(struct peci_sensor_state *state)
{
base-commit: 44696aa3a489d2baf58efa61b37833f100072bee
--
2.43.0
next reply other threads:[~2026-07-12 8:12 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2026-07-12 8:12 Babanpreet Singh [this message]
2026-07-12 8:14 ` [PATCH] hwmon: (peci) Fix kernel-doc parameter names in common.h sashiko-bot
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=20260712081258.7-1-bbnpreetsingh@gmail.com \
--to=bbnpreetsingh@gmail.com \
--cc=iwona.winiarska@intel.com \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.