[PATCH] Documentation/hwmon: Fix description of devm_hwmon_device_unregister

[PATCH] Documentation/hwmon: Fix description of devm_hwmon_device_unregister

[YYang]

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.
 
 All supported hwmon device registration functions only accept valid device
-- 
2.37.1

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

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 399 bytes --]

On Fri, Jun 09, 2023 at 02:42:30AM +0400, YYang wrote:
> 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>

Is your SoB address gmail one (sounds typo here)?

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

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

[Guenter Roeck]

On 6/8/23 18:31, Bagas Sanjaya wrote:
> On Fri, Jun 09, 2023 at 02:42:30AM +0400, YYang wrote:
>> 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>
> 
> Is your SoB address gmail one (sounds typo here)?
> 

Looks like it. YYang - please resubmit with correct SoB.

Thanks,
Guenter

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

[Jonathan Corbet]

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

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

[Yongsheng Yang]

> On 6/8/23 18:31, Bagas Sanjaya wrote:
> > On Fri, Jun 09, 2023 at 02:42:30AM +0400, YYang wrote:
> >> 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>
> > 
> > Is your SoB address gmail one (sounds typo here)?
> > 
> 
> Looks like it. YYang - please resubmit with correct SoB.
> 
> Thanks,
> Guenter

Sorry for my mistake, I fixed the misspelling. Will post the updated version.

Thanks

Yongsheng

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

[Yongsheng Yang]

> 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

Sure, I have modfied the commit message and post the updated version. Thanks
for your advice.

Thanks

Yongsheng