From: Jeff Johnson <quic_jjohnson@quicinc.com>
To: "Rafael J. Wysocki" <rafael@kernel.org>,
Daniel Lezcano <daniel.lezcano@linaro.org>,
Zhang Rui <rui.zhang@intel.com>,
Lukasz Luba <lukasz.luba@arm.com>
Cc: <linux-pm@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
Jeff Johnson <quic_jjohnson@quicinc.com>
Subject: [PATCH] thermal/drivers/max77620: Fix max77620_thermal_read_temp() kernel-doc
Date: Mon, 6 May 2024 09:23:35 -0700 [thread overview]
Message-ID: <20240506-max77620_thermal_read_temp-kdoc-v1-1-679f0486d52c@quicinc.com> (raw)
Fix the following kernel-doc issues reported by make W=1:
drivers/thermal/max77620_thermal.c:48: warning: Function parameter or struct member 'tz' not described in 'max77620_thermal_read_temp'
drivers/thermal/max77620_thermal.c:48: warning: Excess function parameter 'data' description in 'max77620_thermal_read_temp'
Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.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..f0cfe1a8fa94 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: Device specific data.
* @temp: Temperature in millidegrees Celsius
*
* The actual temperature of PMIC die is not available from PMIC.
---
base-commit: dd5a440a31fae6e459c0d6271dddd62825505361
change-id: 20240506-max77620_thermal_read_temp-kdoc-61110a446d53
reply other threads:[~2024-05-06 16:23 UTC|newest]
Thread overview: [no followups] expand[flat|nested] mbox.gz Atom feed
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=20240506-max77620_thermal_read_temp-kdoc-v1-1-679f0486d52c@quicinc.com \
--to=quic_jjohnson@quicinc.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;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).