[PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp

[PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp

[Vivek BalachandharTN]

Building with W=1 reports a kernel-doc warning in
drivers/thermal/max77620_thermal.c:

  Warning: max77620_thermal.c:47 function parameter 'tz'
  not described in 'max77620_thermal_read_temp'

Update the kernel-doc comment for max77620_thermal_read_temp() to match
the current function prototype. Replace the stale @data entry with @tz
and describe the thermal zone device argument so that all parameters are
documented.

This fixes the W=1 kernel-doc warning and keeps the documentation in
sync with the code.

Signed-off-by: Vivek BalachandharTN <vivek.balachandhar@gmail.com>
---
 drivers/thermal/max77620_thermal.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/thermal/max77620_thermal.c b/drivers/thermal/max77620_thermal.c
index 85a12e98d6dc..8d37a04eb5a8 100644
--- a/drivers/thermal/max77620_thermal.c
+++ b/drivers/thermal/max77620_thermal.c
@@ -32,7 +32,7 @@ struct max77620_therm_info {
 
 /**
  * max77620_thermal_read_temp: Read PMIC die temperatue.
- * @data:	Device specific data.
+ * @tz:	Thermal zone device
  * @temp:	Temperature in millidegrees Celsius
  *
  * The actual temperature of PMIC die is not available from PMIC.
-- 
2.34.1

Re: [PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp

[Lukasz Luba]

Hi Vivek,

On 1/13/26 01:54, Vivek BalachandharTN wrote:
> Hi Rafael, Daniel,
> 
> Just a gentle follow-up on this patch — I wanted to check if there are 
> any concerns or if any changes are needed from my side.
> 
> Happy to revise or resend if required.

I think it was just missed.

> 
> Thanks for your time.
> 
> Best,
> Vivek
> 
> 
> On 2025-12-01 1:40 a.m., Vivek BalachandharTN wrote:
>> Building with W=1 reports a kernel-doc warning in
>> drivers/thermal/max77620_thermal.c:
>>
>>    Warning: max77620_thermal.c:47 function parameter 'tz'
>>    not described in 'max77620_thermal_read_temp'
>>
>> Update the kernel-doc comment for max77620_thermal_read_temp() to match
>> the current function prototype. Replace the stale @data entry with @tz
>> and describe the thermal zone device argument so that all parameters are
>> documented.
>>
>> This fixes the W=1 kernel-doc warning and keeps the documentation in
>> sync with the code.
>>
>> Signed-off-by: Vivek BalachandharTN<vivek.balachandhar@gmail.com>
>> ---
>>   drivers/thermal/max77620_thermal.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/thermal/max77620_thermal.c b/drivers/thermal/max77620_thermal.c
>> index 85a12e98d6dc..8d37a04eb5a8 100644
>> --- a/drivers/thermal/max77620_thermal.c
>> +++ b/drivers/thermal/max77620_thermal.c
>> @@ -32,7 +32,7 @@ struct max77620_therm_info {
>>   
>>   /**
>>    * max77620_thermal_read_temp: Read PMIC die temperatue.
>> - * @data:	Device specific data.
>> + * @tz:	Thermal zone device
>>    * @temp:	Temperature in millidegrees Celsius
>>    *
>>    * The actual temperature of PMIC die is not available from PMIC.


The patch looks good. Although, I'm not sure if such change
should go through the stable tree.
Usually we would ask you to add 'Fixes:' line with the
hash of the commit which left that stale comment in this case.
If we were strict to the processes that should be there.
If we judge the effort and traffic for stable-linux folks
I would say, not needed.

Reviewed-by: Lukasz Luba <lukasz.luba@arm.com>

Regards,
Lukasz

Re: [PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp

[Vivek BalachandharTN]

Thanks a lot, Lukasz — appreciate the review.

Understood regarding the Fixes/stable point.
I’ll make sure to include a Fixes tag for similar cases in future 
contributions.

Thanks again.

Best
Vivek


On 2026-01-13 8:30 a.m., Lukasz Luba wrote:
> Hi Vivek,
>
> On 1/13/26 01:54, Vivek BalachandharTN wrote:
>> Hi Rafael, Daniel,
>>
>> Just a gentle follow-up on this patch — I wanted to check if there 
>> are any concerns or if any changes are needed from my side.
>>
>> Happy to revise or resend if required.
>
> I think it was just missed.
>
>>
>> Thanks for your time.
>>
>> Best,
>> Vivek
>>
>>
>> On 2025-12-01 1:40 a.m., Vivek BalachandharTN wrote:
>>> Building with W=1 reports a kernel-doc warning in
>>> drivers/thermal/max77620_thermal.c:
>>>
>>>    Warning: max77620_thermal.c:47 function parameter 'tz'
>>>    not described in 'max77620_thermal_read_temp'
>>>
>>> Update the kernel-doc comment for max77620_thermal_read_temp() to match
>>> the current function prototype. Replace the stale @data entry with @tz
>>> and describe the thermal zone device argument so that all parameters 
>>> are
>>> documented.
>>>
>>> This fixes the W=1 kernel-doc warning and keeps the documentation in
>>> sync with the code.
>>>
>>> Signed-off-by: Vivek BalachandharTN<vivek.balachandhar@gmail.com>
>>> ---
>>>   drivers/thermal/max77620_thermal.c | 2 +-
>>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>>
>>> diff --git a/drivers/thermal/max77620_thermal.c 
>>> b/drivers/thermal/max77620_thermal.c
>>> index 85a12e98d6dc..8d37a04eb5a8 100644
>>> --- a/drivers/thermal/max77620_thermal.c
>>> +++ b/drivers/thermal/max77620_thermal.c
>>> @@ -32,7 +32,7 @@ struct max77620_therm_info {
>>>     /**
>>>    * max77620_thermal_read_temp: Read PMIC die temperatue.
>>> - * @data:    Device specific data.
>>> + * @tz:    Thermal zone device
>>>    * @temp:    Temperature in millidegrees Celsius
>>>    *
>>>    * The actual temperature of PMIC die is not available from PMIC.
>
>
> The patch looks good. Although, I'm not sure if such change
> should go through the stable tree.
> Usually we would ask you to add 'Fixes:' line with the
> hash of the commit which left that stale comment in this case.
> If we were strict to the processes that should be there.
> If we judge the effort and traffic for stable-linux folks
> I would say, not needed.
>
> Reviewed-by: Lukasz Luba <lukasz.luba@arm.com>
>
> Regards,
> Lukasz
>