[PATCH] Documentation/printf: Use literal fwnode_handle

Geert Uytterhoeven posted 1 patch 1 month, 4 weeks ago
Documentation/core-api/printk-formats.rst | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] Documentation/printf: Use literal fwnode_handle
Posted by Geert Uytterhoeven 1 month, 4 weeks ago
When looking for fwnode_handle in the printk format documentation, it is
only found in the Chinese translation:

    $ git grep fwnode_handle -- Documentation/*printk-formats.rst
    Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是打印完整的节点名称,包括路径。

This happens because the original documentation talks about "fwnode
handles", without mentioning the actual type name.

Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
---
 Documentation/core-api/printk-formats.rst | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
index 4b7f3646ec6ce028..7f2f11b482865175 100644
--- a/Documentation/core-api/printk-formats.rst
+++ b/Documentation/core-api/printk-formats.rst
@@ -521,7 +521,7 @@ Fwnode handles
 
 	%pfw[fP]
 
-For printing information on fwnode handles. The default is to print the full
+For printing information on an fwnode_handle. The default is to print the full
 node name, including the path. The modifiers are functionally equivalent to
 %pOF above.
 
-- 
2.43.0

Re: [PATCH] Documentation/printf: Use literal fwnode_handle
Posted by Jonathan Corbet 1 month, 3 weeks ago
Geert Uytterhoeven <geert+renesas@glider.be> writes:

> When looking for fwnode_handle in the printk format documentation, it is
> only found in the Chinese translation:
>
>     $ git grep fwnode_handle -- Documentation/*printk-formats.rst
>     Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是打印完整的节点名称,包括路径。
>
> This happens because the original documentation talks about "fwnode
> handles", without mentioning the actual type name.
>
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>  Documentation/core-api/printk-formats.rst | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
> index 4b7f3646ec6ce028..7f2f11b482865175 100644
> --- a/Documentation/core-api/printk-formats.rst
> +++ b/Documentation/core-api/printk-formats.rst
> @@ -521,7 +521,7 @@ Fwnode handles
>  
>  	%pfw[fP]
>  
> -For printing information on fwnode handles. The default is to print the full
> +For printing information on an fwnode_handle. The default is to print the full
>  node name, including the path. The modifiers are functionally equivalent to

Applied, thanks.

jon
Re: [PATCH] Documentation/printf: Use literal fwnode_handle
Posted by Kunwu Chan 1 month, 3 weeks ago
On 2025/8/7 15:36, Geert Uytterhoeven wrote:
> When looking for fwnode_handle in the printk format documentation, it is
> only found in the Chinese translation:
>
>      $ git grep fwnode_handle -- Documentation/*printk-formats.rst
>      Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是打印完整的节点名称,包括路径。
>
> This happens because the original documentation talks about "fwnode
> handles", without mentioning the actual type name.
>
> Signed-off-by: Geert Uytterhoeven <geert+renesas@glider.be>
> ---
>   Documentation/core-api/printk-formats.rst | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/core-api/printk-formats.rst b/Documentation/core-api/printk-formats.rst
> index 4b7f3646ec6ce028..7f2f11b482865175 100644
> --- a/Documentation/core-api/printk-formats.rst
> +++ b/Documentation/core-api/printk-formats.rst
> @@ -521,7 +521,7 @@ Fwnode handles
>   
>   	%pfw[fP]
>   
> -For printing information on fwnode handles. The default is to print the full
> +For printing information on an fwnode_handle. The default is to print the full
>   node name, including the path. The modifiers are functionally equivalent to
>   %pOF above.
>   

Thanks for the patch.

After apply this patch, test result:

#  git grep fwnode_handle -- Documentation/*printk-formats.rst
Documentation/core-api/printk-formats.rst:For printing information on an 
fwnode_handle. The default is to print the full
Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是
打印完整的节点名称,包括路径。
#

Tested-by: Kunwu Chan <kunwu.chan@linux.dev>

Reviewed-by: Kunwu Chan <kunwu.chan@linux.dev>


-- 
Thanks,
        Kunwu Chan.

Re: [PATCH] Documentation/printf: Use literal fwnode_handle
Posted by Andy Shevchenko 1 month, 3 weeks ago
On Thu, Aug 07, 2025 at 09:36:01AM +0200, Geert Uytterhoeven wrote:
> When looking for fwnode_handle in the printk format documentation, it is
> only found in the Chinese translation:
> 
>     $ git grep fwnode_handle -- Documentation/*printk-formats.rst
>     Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是打印完整的节点名称,包括路径。
> 
> This happens because the original documentation talks about "fwnode
> handles", without mentioning the actual type name.

Fixes?

Anyway, LGTM,
Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

-- 
With Best Regards,
Andy Shevchenko


Re: [PATCH] Documentation/printf: Use literal fwnode_handle
Posted by Geert Uytterhoeven 1 month, 3 weeks ago
Hi Andy,

CC Sakari

On Sat, 9 Aug 2025 at 11:57, Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
> On Thu, Aug 07, 2025 at 09:36:01AM +0200, Geert Uytterhoeven wrote:
> > When looking for fwnode_handle in the printk format documentation, it is
> > only found in the Chinese translation:
> >
> >     $ git grep fwnode_handle -- Documentation/*printk-formats.rst
> >     Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是打印完整的节点名称,包括路径。
> >
> > This happens because the original documentation talks about "fwnode
> > handles", without mentioning the actual type name.
>
> Fixes?

If you insist...

Fixes: 3bd32d6a2ee62db3 ("lib/vsprintf: Add %pfw conversion specifier
for printing fwnode names")

> Anyway, LGTM,
> Reviewed-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Thanks!

Gr{oetje,eeting}s,

                        Geert


--
Geert Uytterhoeven -- There's lots of Linux beyond ia32 -- geert@linux-m68k.org

In personal conversations with technical people, I call myself a hacker. But
when I'm talking to journalists I just say "programmer" or something like that.
                                -- Linus Torvalds
Re: [PATCH] Documentation/printf: Use literal fwnode_handle
Posted by Sakari Ailus 1 month, 3 weeks ago
Hi Geert,

On Sun, Aug 10, 2025 at 09:33:50AM +0200, Geert Uytterhoeven wrote:
> Hi Andy,
> 
> CC Sakari
> 
> On Sat, 9 Aug 2025 at 11:57, Andy Shevchenko
> <andriy.shevchenko@linux.intel.com> wrote:
> > On Thu, Aug 07, 2025 at 09:36:01AM +0200, Geert Uytterhoeven wrote:
> > > When looking for fwnode_handle in the printk format documentation, it is
> > > only found in the Chinese translation:
> > >
> > >     $ git grep fwnode_handle -- Documentation/*printk-formats.rst
> > >     Documentation/translations/zh_CN/core-api/printk-formats.rst:用于打印fwnode_handles的消息。默认情况下是打印完整的节点名称,包括路径。
> > >
> > > This happens because the original documentation talks about "fwnode
> > > handles", without mentioning the actual type name.
> >
> > Fixes?
> 
> If you insist...
> 
> Fixes: 3bd32d6a2ee62db3 ("lib/vsprintf: Add %pfw conversion specifier
> for printing fwnode names")

Thanks for the patch.

Reviewed-by: Sakari Ailus <sakari.ailus@linux.intel.com>

-- 
Regards,

Sakari Ailus