Re: [PATCH] hwmon: (peci) Fix kernel-doc parameter names in common.h

[Guenter Roeck]

On Sun, Jul 12, 2026 at 08:12:58AM +0000, Babanpreet Singh wrote:
> 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@xxxxxxxxx>

Applied.

Thanks,
Guenter