* [PATCH] of: linux/of.h: fix kernel-doc warnings
@ 2021-04-17 6:12 Randy Dunlap
2021-04-21 13:05 ` Rob Herring
0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2021-04-17 6:12 UTC (permalink / raw)
To: linux-kernel; +Cc: Randy Dunlap, Rob Herring, Greg Kroah-Hartman
Correct kernel-doc notation warnings:
../include/linux/of.h:1211: warning: Function parameter or member 'output' not described in 'of_property_read_string_index'
../include/linux/of.h:1211: warning: Excess function parameter 'out_string' description in 'of_property_read_string_index'
../include/linux/of.h:1477: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
* Overlay support
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Rob Herring <robh@kernel.org>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
---
include/linux/of.h | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
--- linux-next-20210416.orig/include/linux/of.h
+++ linux-next-20210416/include/linux/of.h
@@ -1192,7 +1192,7 @@ static inline int of_property_count_stri
* @np: device node from which the property value is to be read.
* @propname: name of the property to be searched.
* @index: index of the string in the list of strings
- * @out_string: pointer to null terminated return string, modified only if
+ * @output: pointer to null terminated return string, modified only if
* return value is 0.
*
* Search for a property in a device tree node and retrieve a null
@@ -1473,7 +1473,7 @@ static inline bool of_device_is_system_p
return of_property_read_bool(np, "system-power-controller");
}
-/**
+/*
* Overlay support
*/
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: [PATCH] of: linux/of.h: fix kernel-doc warnings
2021-04-17 6:12 [PATCH] of: linux/of.h: fix kernel-doc warnings Randy Dunlap
@ 2021-04-21 13:05 ` Rob Herring
0 siblings, 0 replies; 2+ messages in thread
From: Rob Herring @ 2021-04-21 13:05 UTC (permalink / raw)
To: Randy Dunlap; +Cc: linux-kernel, Greg Kroah-Hartman
On Fri, 16 Apr 2021 23:12:44 -0700, Randy Dunlap wrote:
> Correct kernel-doc notation warnings:
>
> ../include/linux/of.h:1211: warning: Function parameter or member 'output' not described in 'of_property_read_string_index'
> ../include/linux/of.h:1211: warning: Excess function parameter 'out_string' description in 'of_property_read_string_index'
> ../include/linux/of.h:1477: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> * Overlay support
>
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> Cc: Rob Herring <robh@kernel.org>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> ---
> include/linux/of.h | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
Applied, thanks!
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2021-04-21 13:07 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-17 6:12 [PATCH] of: linux/of.h: fix kernel-doc warnings Randy Dunlap
2021-04-21 13:05 ` Rob Herring
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).