Documentation: reset: Use fwnode_reset_simple_xlate() in the kernel-doc directive

[PATCH] Documentation: reset: Use fwnode_reset_simple_xlate() in the kernel-doc directive

Posted by Karl Mehltretter 2 weeks, 6 days ago

reset.rst asks drivers/reset/core.c for of_reset_simple_xlate(). Commit
9035073d0ef1 ("reset: convert reset core to using firmware nodes")
replaced it with fwnode_reset_simple_xlate(). Since then the directive
finds nothing for it and the default translation helper is missing from
the rendered controller API section.

Use the current name.

Fixes: 9035073d0ef1 ("reset: convert reset core to using firmware nodes")
Assisted-by: LLM
Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
---
 Documentation/driver-api/reset.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/driver-api/reset.rst b/Documentation/driver-api/reset.rst
index 7a6571849664..932699c57d1e 100644
--- a/Documentation/driver-api/reset.rst
+++ b/Documentation/driver-api/reset.rst
@@ -213,7 +213,7 @@ devm_reset_controller_register().
    :internal:
 
 .. kernel-doc:: drivers/reset/core.c
-   :functions: of_reset_simple_xlate
+   :functions: fwnode_reset_simple_xlate
                reset_controller_register
                reset_controller_unregister
                devm_reset_controller_register
-- 
2.53.0

Re: [PATCH] Documentation: reset: Use fwnode_reset_simple_xlate() in the kernel-doc directive

Posted by Jonathan Corbet 2 weeks, 4 days ago

Karl Mehltretter <kmehltretter@gmail.com> writes:

> reset.rst asks drivers/reset/core.c for of_reset_simple_xlate(). Commit
> 9035073d0ef1 ("reset: convert reset core to using firmware nodes")
> replaced it with fwnode_reset_simple_xlate(). Since then the directive
> finds nothing for it and the default translation helper is missing from
> the rendered controller API section.
>
> Use the current name.
>
> Fixes: 9035073d0ef1 ("reset: convert reset core to using firmware nodes")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>
> ---
>  Documentation/driver-api/reset.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/driver-api/reset.rst b/Documentation/driver-api/reset.rst
> index 7a6571849664..932699c57d1e 100644
> --- a/Documentation/driver-api/reset.rst
> +++ b/Documentation/driver-api/reset.rst
> @@ -213,7 +213,7 @@ devm_reset_controller_register().
>     :internal:
>  
>  .. kernel-doc:: drivers/reset/core.c
> -   :functions: of_reset_simple_xlate
> +   :functions: fwnode_reset_simple_xlate
>                 reset_controller_register

Applied, thanks.

jon

Re: [PATCH] Documentation: reset: Use fwnode_reset_simple_xlate() in the kernel-doc directive

Posted by Randy Dunlap 2 weeks, 6 days ago


On 9/5/26 1:52 AM, Karl Mehltretter wrote:
> reset.rst asks drivers/reset/core.c for of_reset_simple_xlate(). Commit
> 9035073d0ef1 ("reset: convert reset core to using firmware nodes")
> replaced it with fwnode_reset_simple_xlate(). Since then the directive
> finds nothing for it and the default translation helper is missing from
> the rendered controller API section.
> 
> Use the current name.
> 
> Fixes: 9035073d0ef1 ("reset: convert reset core to using firmware nodes")
> Assisted-by: LLM
> Signed-off-by: Karl Mehltretter <kmehltretter@gmail.com>

Acked-by: Randy Dunlap <rdunlap@infradead.org>
Thanks.
 
> ---
>  Documentation/driver-api/reset.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/driver-api/reset.rst b/Documentation/driver-api/reset.rst
> index 7a6571849664..932699c57d1e 100644
> --- a/Documentation/driver-api/reset.rst
> +++ b/Documentation/driver-api/reset.rst
> @@ -213,7 +213,7 @@ devm_reset_controller_register().
>     :internal:
>  
>  .. kernel-doc:: drivers/reset/core.c
> -   :functions: of_reset_simple_xlate
> +   :functions: fwnode_reset_simple_xlate
>                 reset_controller_register
>                 reset_controller_unregister
>                 devm_reset_controller_register

-- 
~Randy