Re: [PATCH] Documentation/hwmon: Fix description of devm_hwmon_device_unregister

From: Jonathan Corbet
Date: Fri Jun 09 2023 - 02:45:21 EST


YYang <iyysheng@xxxxxxxxx> writes:

> From: YYang <iyysheng@xxxxxxxx>
>
> 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@xxxxxxxx>
> ---
> 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