Commit adaa0a9f authored Apr 02, 2022 by Yang Li Committed by Steven Rostedt (Google) Apr 26, 2022

tracing: Fix tracing_map_sort_entries() kernel-doc comment

Add the description of @n_sort_keys and make @sort_key ->
@sort_keys in tracing_map_sort_entries() kernel-doc comment
to remove warnings found by running scripts/kernel-doc, which
is caused by using 'make W=1'.

kernel/trace/tracing_map.c:1073: warning: Function parameter or member
'sort_keys' not described in 'tracing_map_sort_entries'
kernel/trace/tracing_map.c:1073: warning: Function parameter or member
'n_sort_keys' not described in 'tracing_map_sort_entries'
kernel/trace/tracing_map.c:1073: warning: Excess function parameter
'sort_key' description in 'tracing_map_sort_entries'

Link: https://lkml.kernel.org/r/20220402072015.45864-1-yang.lee@linux.alibaba.com



Reported-by: Abaci Robot <abaci@linux.alibaba.com>
Signed-off-by: Yang Li <yang.lee@linux.alibaba.com>
Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

parent 3eaf17f5

kernel/trace/tracing_map.c

+2 −1

Original line number	Diff line number	Diff line
		@@ -1045,7 +1045,8 @@ static void sort_secondary(struct tracing_map *map,
		/**
		* tracing_map_sort_entries - Sort the current set of tracing_map_elts in a map
		* @map: The tracing_map
		* @sort_key: The sort key to use for sorting
		* @sort_keys: The sort key to use for sorting
		* @n_sort_keys: hitcount, always have at least one
		* @sort_entries: outval: pointer to allocated and sorted array of entries
		*
		* tracing_map_sort_entries() sorts the current set of entries in the