diff options
| author | Babanpreet Singh <bbnpreetsingh@gmail.com> | 2026-07-12 08:12:58 +0000 |
|---|---|---|
| committer | Guenter Roeck <linux@roeck-us.net> | 2026-07-27 20:30:43 -0700 |
| commit | 4fffc0977a87eddea828eb8b9d643ab87232bdd1 (patch) | |
| tree | 50d26e943650a0d2d2301808d92e23286b5381f1 /drivers | |
| parent | abd9590132a3dfe0f4da9e58fe44507c8f2f95f5 (diff) | |
| download | linux-next-4fffc0977a87eddea828eb8b9d643ab87232bdd1.tar.gz linux-next-4fffc0977a87eddea828eb8b9d643ab87232bdd1.zip | |
hwmon: (peci) Fix kernel-doc parameter names in common.h
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>
Link: https://lore.kernel.org/r/20260712081258.7-1-bbnpreetsingh@gmail.com
Signed-off-by: Guenter Roeck <linux@roeck-us.net>
Diffstat (limited to 'drivers')
| -rw-r--r-- | drivers/hwmon/peci/common.h | 4 |
1 files 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) { |