[trace:bootconfig/fixes 4/4] lib/bootconfig.c:911: warning: Function parameter or struct member 'early' not described in '_xbc_exit'

[trace:bootconfig/fixes 4/4] lib/bootconfig.c:911: warning: Function parameter or struct member 'early' not described in '_xbc_exit'

[kernel test robot]

tree:   git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace bootconfig/fixes
head:   89f9a1e876b5a7ad884918c03a46831af202c8a0
commit: 89f9a1e876b5a7ad884918c03a46831af202c8a0 [4/4] bootconfig: use memblock_free_late to free xbc memory to buddy
config: x86_64-allyesconfig (https://download.01.org/0day-ci/archive/20240415/202404150036.kPJ3HEFA-lkp@intel.com/config)
compiler: clang version 17.0.6 (https://github.com/llvm/llvm-project 6009708b4367171ccdbf4b5905cb6a803753fe18)
reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240415/202404150036.kPJ3HEFA-lkp@intel.com/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <lkp@intel.com>
| Closes: https://lore.kernel.org/oe-kbuild-all/202404150036.kPJ3HEFA-lkp@intel.com/

All warnings (new ones prefixed by >>):

>> lib/bootconfig.c:911: warning: Function parameter or struct member 'early' not described in '_xbc_exit'
>> lib/bootconfig.c:911: warning: expecting prototype for xbc_exit(). Prototype was for _xbc_exit() instead


vim +911 lib/bootconfig.c

f3668cde856299 Masami Hiramatsu 2021-09-17  902  
76db5a27a827c2 Masami Hiramatsu 2020-01-11  903  /**
115d4d08aeb942 Masami Hiramatsu 2021-09-17  904   * xbc_exit() - Clean up all parsed bootconfig
76db5a27a827c2 Masami Hiramatsu 2020-01-11  905   *
76db5a27a827c2 Masami Hiramatsu 2020-01-11  906   * This clears all data structures of parsed bootconfig on memory.
76db5a27a827c2 Masami Hiramatsu 2020-01-11  907   * If you need to reuse xbc_init() with new boot config, you can
76db5a27a827c2 Masami Hiramatsu 2020-01-11  908   * use this.
76db5a27a827c2 Masami Hiramatsu 2020-01-11  909   */
89f9a1e876b5a7 Qiang Zhang      2024-04-14  910  void __init _xbc_exit(bool early)
76db5a27a827c2 Masami Hiramatsu 2020-01-11 @911  {
89f9a1e876b5a7 Qiang Zhang      2024-04-14  912  	xbc_free_mem(xbc_data, xbc_data_size, early);
76db5a27a827c2 Masami Hiramatsu 2020-01-11  913  	xbc_data = NULL;
76db5a27a827c2 Masami Hiramatsu 2020-01-11  914  	xbc_data_size = 0;
76db5a27a827c2 Masami Hiramatsu 2020-01-11  915  	xbc_node_num = 0;
89f9a1e876b5a7 Qiang Zhang      2024-04-14  916  	xbc_free_mem(xbc_nodes, sizeof(struct xbc_node) * XBC_NODE_MAX, early);
a91e4f12ffc42f Masami Hiramatsu 2020-02-07  917  	xbc_nodes = NULL;
ead1e19ad905b9 Masami Hiramatsu 2020-09-21  918  	brace_index = 0;
76db5a27a827c2 Masami Hiramatsu 2020-01-11  919  }
76db5a27a827c2 Masami Hiramatsu 2020-01-11  920  

:::::: The code at line 911 was first introduced by commit
:::::: 76db5a27a827c2c89e5120a3d486472da847863b bootconfig: Add Extra Boot Config support

:::::: TO: Masami Hiramatsu <mhiramat@kernel.org>
:::::: CC: Steven Rostedt (VMware) <rostedt@goodmis.org>

-- 
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

Re: [trace:bootconfig/fixes 4/4] lib/bootconfig.c:911: warning: Function parameter or struct member 'early' not described in '_xbc_exit'

[Masami Hiramatsu]

On Mon, 15 Apr 2024 00:26:07 +0800
kernel test robot <lkp@intel.com> wrote:

> tree:   git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace bootconfig/fixes
> head:   89f9a1e876b5a7ad884918c03a46831af202c8a0
> commit: 89f9a1e876b5a7ad884918c03a46831af202c8a0 [4/4] bootconfig: use memblock_free_late to free xbc memory to buddy
> config: x86_64-allyesconfig (https://download.01.org/0day-ci/archive/20240415/202404150036.kPJ3HEFA-lkp@intel.com/config)
> compiler: clang version 17.0.6 (https://github.com/llvm/llvm-project 6009708b4367171ccdbf4b5905cb6a803753fe18)
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20240415/202404150036.kPJ3HEFA-lkp@intel.com/reproduce)
> 
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <lkp@intel.com>
> | Closes: https://lore.kernel.org/oe-kbuild-all/202404150036.kPJ3HEFA-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
> >> lib/bootconfig.c:911: warning: Function parameter or struct member 'early' not described in '_xbc_exit'
> >> lib/bootconfig.c:911: warning: expecting prototype for xbc_exit(). Prototype was for _xbc_exit() instead

Ok, I didn't check the kernel doc part.
Let me fix this.

Thank you,

> 
> 
> vim +911 lib/bootconfig.c
> 
> f3668cde856299 Masami Hiramatsu 2021-09-17  902  
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  903  /**
> 115d4d08aeb942 Masami Hiramatsu 2021-09-17  904   * xbc_exit() - Clean up all parsed bootconfig
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  905   *
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  906   * This clears all data structures of parsed bootconfig on memory.
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  907   * If you need to reuse xbc_init() with new boot config, you can
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  908   * use this.
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  909   */
> 89f9a1e876b5a7 Qiang Zhang      2024-04-14  910  void __init _xbc_exit(bool early)
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11 @911  {
> 89f9a1e876b5a7 Qiang Zhang      2024-04-14  912  	xbc_free_mem(xbc_data, xbc_data_size, early);
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  913  	xbc_data = NULL;
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  914  	xbc_data_size = 0;
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  915  	xbc_node_num = 0;
> 89f9a1e876b5a7 Qiang Zhang      2024-04-14  916  	xbc_free_mem(xbc_nodes, sizeof(struct xbc_node) * XBC_NODE_MAX, early);
> a91e4f12ffc42f Masami Hiramatsu 2020-02-07  917  	xbc_nodes = NULL;
> ead1e19ad905b9 Masami Hiramatsu 2020-09-21  918  	brace_index = 0;
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  919  }
> 76db5a27a827c2 Masami Hiramatsu 2020-01-11  920  
> 
> :::::: The code at line 911 was first introduced by commit
> :::::: 76db5a27a827c2c89e5120a3d486472da847863b bootconfig: Add Extra Boot Config support
> 
> :::::: TO: Masami Hiramatsu <mhiramat@kernel.org>
> :::::: CC: Steven Rostedt (VMware) <rostedt@goodmis.org>
> 
> -- 
> 0-DAY CI Kernel Test Service
> https://github.com/intel/lkp-tests/wiki


-- 
Masami Hiramatsu (Google) <mhiramat@kernel.org>

[PATCH] bootconfig: Fix the kerneldoc of _xbc_exit()

[Masami Hiramatsu (Google)]

From: Masami Hiramatsu (Google) <mhiramat@kernel.org>

Fix the kerneldoc of _xbc_exit() which is updated to have an @early
argument and the function name is changed.

Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202404150036.kPJ3HEFA-lkp@intel.com/
Signed-off-by: Masami Hiramatsu (Google) <mhiramat@kernel.org>
---
 lib/bootconfig.c |    3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/bootconfig.c b/lib/bootconfig.c
index 8841554432d5..97f8911ea339 100644
--- a/lib/bootconfig.c
+++ b/lib/bootconfig.c
@@ -901,7 +901,8 @@ static int __init xbc_parse_tree(void)
 }
 
 /**
- * xbc_exit() - Clean up all parsed bootconfig
+ * _xbc_exit() - Clean up all parsed bootconfig
+ * @early: Set true if this is called before budy system is initialized.
  *
  * This clears all data structures of parsed bootconfig on memory.
  * If you need to reuse xbc_init() with new boot config, you can