mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Vivek BalachandharTN <vivek.balachandhar@gmail.com>
To: "Rafael J . Wysocki" <rafael@kernel.org>,
	Daniel Lezcano <daniel.lezcano@linaro.org>
Cc: Zhang Rui <rui.zhang@intel.com>,
	Lukasz Luba <lukasz.luba@arm.com>,
	linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
	Vivek Balachandhar TN <vivek.balachandhar@gmail.com>
Subject: [PATCH] thermal: max77620: fix kernel-doc for max77620_thermal_read_temp
Date: Mon,  1 Dec 2025 05:40:36 +0000	[thread overview]
Message-ID: <20251201054036.2143455-1-vivek.balachandhar@gmail.com> (raw)

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


             reply	other threads:[~2025-12-01  5:40 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-12-01  5:40 Vivek BalachandharTN [this message]
     [not found] ` <2a3dc51e-ead2-4612-bf7f-6cdb49bf9570@gmail.com>
2026-01-13 12:30   ` Lukasz Luba
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=20251201054036.2143455-1-vivek.balachandhar@gmail.com \
    --to=vivek.balachandhar@gmail.com \
    --cc=daniel.lezcano@linaro.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pm@vger.kernel.org \
    --cc=lukasz.luba@arm.com \
    --cc=rafael@kernel.org \
    --cc=rui.zhang@intel.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®