mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Lukasz Luba <lukasz.luba@arm.com>
To: Vivek BalachandharTN <vivek.balachandhar@gmail.com>
Cc: Zhang Rui <rui.zhang@intel.com>,
	linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
	"Rafael J . Wysocki" <rafael@kernel.org>,
	Daniel Lezcano <daniel.lezcano@linaro.org>
Subject: Re: [PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp
Date: Tue, 13 Jan 2026 12:30:22 +0000	[thread overview]
Message-ID: <12ba1c1d-fb20-476c-ae24-3e1007afb199@arm.com> (raw)
In-Reply-To: <2a3dc51e-ead2-4612-bf7f-6cdb49bf9570@gmail.com>

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


  parent reply	other threads:[~2026-01-13 12:30 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-01  5:40 Vivek BalachandharTN
     [not found] ` <2a3dc51e-ead2-4612-bf7f-6cdb49bf9570@gmail.com>
2026-01-13 12:30   ` Lukasz Luba [this message]
2026-01-13 17:23     ` Vivek BalachandharTN

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=12ba1c1d-fb20-476c-ae24-3e1007afb199@arm.com \
    --to=lukasz.luba@arm.com \
    --cc=daniel.lezcano@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=rafael@kernel.org \
    --cc=rui.zhang@intel.com \
    --cc=vivek.balachandhar@gmail.com \
    /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

all inboxes | Powered by JetHome®