From: Jonathan Corbet <corbet@lwn.net>
To: YYang <iyysheng@gmail.com>, jdelvare@suse.com, linux@roeck-us.net
Cc: linux-hwmon@vger.kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org, YYang <iyysheng@gmai.com>
Subject: Re: [PATCH] Documentation/hwmon: Fix description of devm_hwmon_device_unregister
Date: Fri, 09 Jun 2023 00:45:00 -0600 [thread overview]
Message-ID: <871qilqglv.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230608224231.1156-1-iyysheng@gmail.com>
YYang <iyysheng@gmail.com> writes:
> From: YYang <iyysheng@gmai.com>
>
> Use devm_hwmon_device_register_with_info to replace
> hwmon_device_register_with_info in description of
> devm_hwmon_device_unregister.
>
> Signed-off-by: YYang <iyysheng@gmai.com>
> ---
> Documentation/hwmon/hwmon-kernel-api.rst | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/hwmon/hwmon-kernel-api.rst b/Documentation/hwmon/hwmon-kernel-api.rst
> index c2d1e0299d8d..6cacf7daf25c 100644
> --- a/Documentation/hwmon/hwmon-kernel-api.rst
> +++ b/Documentation/hwmon/hwmon-kernel-api.rst
> @@ -66,7 +66,7 @@ hwmon_device_register_with_info.
>
> devm_hwmon_device_unregister does not normally have to be called. It is only
> needed for error handling, and only needed if the driver probe fails after
> -the call to hwmon_device_register_with_info and if the automatic (device
> +the call to devm_hwmon_device_register_with_info and if the automatic (device
> managed) removal would be too late.
If, while you're at it, you add the trailing parentheses() to the
function name, then the docs build will automatically make a cross-link
to the documentation.
Thanks,
jon
next prev parent reply other threads:[~2023-06-09 6:45 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-08 22:42 [PATCH] Documentation/hwmon: Fix description of devm_hwmon_device_unregister YYang
2023-06-09 1:31 ` Bagas Sanjaya
2023-06-09 1:51 ` Guenter Roeck
2023-06-09 7:47 ` Yongsheng Yang
2023-06-09 6:45 ` Jonathan Corbet [this message]
2023-06-09 8:39 ` Yongsheng Yang
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=871qilqglv.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=iyysheng@gmai.com \
--cc=iyysheng@gmail.com \
--cc=jdelvare@suse.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-hwmon@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux@roeck-us.net \
/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