* linux-next: build warning after merge of the ftrace tree
@ 2021-10-25 23:35 Stephen Rothwell
2021-10-26 12:15 ` Masami Hiramatsu
2021-10-26 12:21 ` [PATCH] lib/bootconfig: Fix the xbc_get_info kerneldoc Masami Hiramatsu
0 siblings, 2 replies; 3+ messages in thread
From: Stephen Rothwell @ 2021-10-25 23:35 UTC (permalink / raw)
To: Steven Rostedt
Cc: Masami Hiramatsu, Linux Kernel Mailing List, Linux Next Mailing List
[-- Attachment #1: Type: text/plain, Size: 449 bytes --]
Hi all,
After merging the ftrace tree, today's linux-next build (htmldocs)
produced this warning:
lib/bootconfig.c:78: warning: Function parameter or member 'node_size' not described in 'xbc_get_info'
lib/bootconfig.c:78: warning: Function parameter or member 'data_size' not described in 'xbc_get_info'
Introduced by commit
e306220cb7b7 ("bootconfig: Add xbc_get_info() for the node information")
--
Cheers,
Stephen Rothwell
[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: linux-next: build warning after merge of the ftrace tree
2021-10-25 23:35 linux-next: build warning after merge of the ftrace tree Stephen Rothwell
@ 2021-10-26 12:15 ` Masami Hiramatsu
2021-10-26 12:21 ` [PATCH] lib/bootconfig: Fix the xbc_get_info kerneldoc Masami Hiramatsu
1 sibling, 0 replies; 3+ messages in thread
From: Masami Hiramatsu @ 2021-10-26 12:15 UTC (permalink / raw)
To: Stephen Rothwell
Cc: Steven Rostedt, Masami Hiramatsu, Linux Kernel Mailing List,
Linux Next Mailing List
On Tue, 26 Oct 2021 10:35:53 +1100
Stephen Rothwell <sfr@canb.auug.org.au> wrote:
> Hi all,
>
> After merging the ftrace tree, today's linux-next build (htmldocs)
> produced this warning:
>
> lib/bootconfig.c:78: warning: Function parameter or member 'node_size' not described in 'xbc_get_info'
> lib/bootconfig.c:78: warning: Function parameter or member 'data_size' not described in 'xbc_get_info'
>
> Introduced by commit
>
> e306220cb7b7 ("bootconfig: Add xbc_get_info() for the node information")
Oops, thanks for reporting! I just missed '@' for those parameters...
Thank you,
>
> --
> Cheers,
> Stephen Rothwell
--
Masami Hiramatsu <mhiramat@kernel.org>
^ permalink raw reply [flat|nested] 3+ messages in thread
* [PATCH] lib/bootconfig: Fix the xbc_get_info kerneldoc
2021-10-25 23:35 linux-next: build warning after merge of the ftrace tree Stephen Rothwell
2021-10-26 12:15 ` Masami Hiramatsu
@ 2021-10-26 12:21 ` Masami Hiramatsu
1 sibling, 0 replies; 3+ messages in thread
From: Masami Hiramatsu @ 2021-10-26 12:21 UTC (permalink / raw)
To: Steven Rostedt
Cc: Masami Hiramatsu, Linux Kernel Mailing List, Linux Next Mailing List
Fix the kernel doc of xbc_get_info() to add '@' to the parameters.
Fixes: e306220cb7b7 ("bootconfig: Add xbc_get_info() for the node information")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Masami Hiramatsu <mhiramat@kernel.org>
---
lib/bootconfig.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/lib/bootconfig.c b/lib/bootconfig.c
index 3276675b25e1..a10ab25f6fcc 100644
--- a/lib/bootconfig.c
+++ b/lib/bootconfig.c
@@ -67,8 +67,8 @@ static inline void xbc_free_mem(void *addr, size_t size)
#endif
/**
* xbc_get_info() - Get the information of loaded boot config
- * node_size: A pointer to store the number of nodes.
- * data_size: A pointer to store the size of bootconfig data.
+ * @node_size: A pointer to store the number of nodes.
+ * @data_size: A pointer to store the size of bootconfig data.
*
* Get the number of used nodes in @node_size if it is not NULL,
* and the size of bootconfig data in @data_size if it is not NULL.
^ permalink raw reply related [flat|nested] 3+ messages in thread
end of thread, other threads:[~2021-10-26 12:21 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-10-25 23:35 linux-next: build warning after merge of the ftrace tree Stephen Rothwell
2021-10-26 12:15 ` Masami Hiramatsu
2021-10-26 12:21 ` [PATCH] lib/bootconfig: Fix the xbc_get_info kerneldoc Masami Hiramatsu
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).