Re: kernel/trace/ftrace.c:1256: warning: Function parameter or struct member 'ops' not described in 'ftrace_free_filter'

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

On Mon, 18 Dec 2023 05:53:57 +0800
kernel test robot <lkp@intel.com> wrote:

> tree:   https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head:   0e389834672c723435a44818ed2cabc4dad24429
> commit: 8be9fbd5345da52f4a74f7f81d55ff9fa0a2958e ftrace: Export ftrace_free_filter() to modules
> date:   11 months ago
> config: i386-randconfig-054-20231216 (https://download.01.org/0day-ci/archive/20231218/202312180518.X6fRyDSN-lkp@intel.com/config)
> compiler: gcc-9 (Debian 9.3.0-22) 9.3.0
> reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20231218/202312180518.X6fRyDSN-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/202312180518.X6fRyDSN-lkp@intel.com/
> 
> All warnings (new ones prefixed by >>):
> 
> >> kernel/trace/ftrace.c:1256: warning: Function parameter or struct member 'ops' not described in 'ftrace_free_filter'
>    kernel/trace/ftrace.c:5709: warning: Function parameter or struct member 'addr' not described in 'unregister_ftrace_direct_multi'
>    kernel/trace/ftrace.c:5854: warning: Function parameter or struct member 'ops' not described in 'ftrace_set_filter_ip'
>    kernel/trace/ftrace.c:5854: warning: Function parameter or struct member 'ip' not described in 'ftrace_set_filter_ip'
>    kernel/trace/ftrace.c:5854: warning: Function parameter or struct member 'remove' not described in 'ftrace_set_filter_ip'
>    kernel/trace/ftrace.c:5854: warning: Function parameter or struct member 'reset' not described in 'ftrace_set_filter_ip'
>    kernel/trace/ftrace.c:5877: warning: Function parameter or struct member 'ops' not described in 'ftrace_set_filter_ips'
>    kernel/trace/ftrace.c:5877: warning: Function parameter or struct member 'ips' not described in 'ftrace_set_filter_ips'
>    kernel/trace/ftrace.c:5877: warning: Function parameter or struct member 'cnt' not described in 'ftrace_set_filter_ips'
>    kernel/trace/ftrace.c:5877: warning: Function parameter or struct member 'remove' not described in 'ftrace_set_filter_ips'
>    kernel/trace/ftrace.c:5877: warning: Function parameter or struct member 'reset' not described in 'ftrace_set_filter_ips'
>    kernel/trace/ftrace.c:5891: warning: Function parameter or struct member 'ops' not described in 'ftrace_ops_set_global_filter'
>    kernel/trace/ftrace.c:5923: warning: Function parameter or struct member 'ops' not described in 'ftrace_set_filter'
>    kernel/trace/ftrace.c:5923: warning: Function parameter or struct member 'buf' not described in 'ftrace_set_filter'
>    kernel/trace/ftrace.c:5923: warning: Function parameter or struct member 'len' not described in 'ftrace_set_filter'
>    kernel/trace/ftrace.c:5923: warning: Function parameter or struct member 'reset' not described in 'ftrace_set_filter'
>    kernel/trace/ftrace.c:5946: warning: Function parameter or struct member 'ops' not described in 'ftrace_set_notrace'
>    kernel/trace/ftrace.c:5946: warning: Function parameter or struct member 'buf' not described in 'ftrace_set_notrace'
>    kernel/trace/ftrace.c:5946: warning: Function parameter or struct member 'len' not described in 'ftrace_set_notrace'
>    kernel/trace/ftrace.c:5946: warning: Function parameter or struct member 'reset' not described in 'ftrace_set_notrace'
>    kernel/trace/ftrace.c:5961: warning: Function parameter or struct member 'buf' not described in 'ftrace_set_global_filter'
>    kernel/trace/ftrace.c:5961: warning: Function parameter or struct member 'len' not described in 'ftrace_set_global_filter'
>    kernel/trace/ftrace.c:5961: warning: Function parameter or struct member 'reset' not described in 'ftrace_set_global_filter'
>    kernel/trace/ftrace.c:5977: warning: Function parameter or struct member 'buf' not described in 'ftrace_set_global_notrace'
>    kernel/trace/ftrace.c:5977: warning: Function parameter or struct member 'len' not described in 'ftrace_set_global_notrace'
>    kernel/trace/ftrace.c:5977: warning: Function parameter or struct member 'reset' not described in 'ftrace_set_global_notrace'
> 
> 
> vim +1256 kernel/trace/ftrace.c
> 
> 07fd5515f3b5c2 Steven Rostedt           2011-05-05  1250  
> 8be9fbd5345da5 Mark Rutland             2023-01-03  1251  /**
> 8be9fbd5345da5 Mark Rutland             2023-01-03  1252   * ftrace_free_filter - remove all filters for an ftrace_ops
> 8be9fbd5345da5 Mark Rutland             2023-01-03  1253   * @ops - the ops to remove the filters from

Ah, this line should be `@ops: the ops to remove the filters from` ('-' -> ':')
And there seems so many similar errors.

Thanks, 

> 8be9fbd5345da5 Mark Rutland             2023-01-03  1254   */
> 5500fa51199aee Jiri Olsa                2012-02-15  1255  void ftrace_free_filter(struct ftrace_ops *ops)
> 5500fa51199aee Jiri Olsa                2012-02-15 @1256  {
> f04f24fb7e48d4 Masami Hiramatsu         2013-05-09  1257  	ftrace_ops_init(ops);
> 33b7f99cf003ca Steven Rostedt (Red Hat  2014-08-15  1258) 	free_ftrace_hash(ops->func_hash->filter_hash);
> 33b7f99cf003ca Steven Rostedt (Red Hat  2014-08-15  1259) 	free_ftrace_hash(ops->func_hash->notrace_hash);
> 5500fa51199aee Jiri Olsa                2012-02-15  1260  }
> 8be9fbd5345da5 Mark Rutland             2023-01-03  1261  EXPORT_SYMBOL_GPL(ftrace_free_filter);
> 5500fa51199aee Jiri Olsa                2012-02-15  1262  
> 
> :::::: The code at line 1256 was first introduced by commit
> :::::: 5500fa51199aee770ce53718853732600543619e ftrace, perf: Add filter support for function trace event
> 
> :::::: TO: Jiri Olsa <jolsa@redhat.com>
> :::::: CC: Steven Rostedt <rostedt@goodmis.org>
> 
> -- 
> 0-DAY CI Kernel Test Service
> https://github.com/intel/lkp-tests/wiki


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