[for-next][PATCH] tracing: Fix trace_pid_list_free() kernel-doc

Steven Rostedt posted 1 patch 1 year, 6 months ago
kernel/trace/pid_list.c | 1 +
1 file changed, 1 insertion(+)
[for-next][PATCH] tracing: Fix trace_pid_list_free() kernel-doc
Posted by Steven Rostedt 1 year, 6 months ago
  git://git.kernel.org/pub/scm/linux/kernel/git/trace/linux-trace.git
trace/for-next

Head SHA1: 22b639253ec046d66c69c54b9d28bb1bd30f3a7a


Jeff Johnson (1):
      tracing: Fix trace_pid_list_free() kernel-doc

----
 kernel/trace/pid_list.c | 1 +
 1 file changed, 1 insertion(+)
---------------------------
commit 22b639253ec046d66c69c54b9d28bb1bd30f3a7a
Author: Jeff Johnson <quic_jjohnson@quicinc.com>
Date:   Mon May 6 07:22:33 2024 -0700

    tracing: Fix trace_pid_list_free() kernel-doc
    
    make C=1 reports:
    
    kernel/trace/pid_list.c:458: warning: Function parameter or struct member 'pid_list' not described in 'trace_pid_list_free'
    
    Add the missing parameter to the trace_pid_list_free() kernel-doc.
    
    Link: https://lore.kernel.org/linux-trace-kernel/20240506-trace_pid_list_free-kdoc-v1-1-c70f0ae29144@quicinc.com
    
    Cc: Masami Hiramatsu <mhiramat@kernel.org>
    Cc: Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
    Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
    Signed-off-by: Steven Rostedt (Google) <rostedt@goodmis.org>

diff --git a/kernel/trace/pid_list.c b/kernel/trace/pid_list.c
index 95106d02b32d..19b271a12c99 100644
--- a/kernel/trace/pid_list.c
+++ b/kernel/trace/pid_list.c
@@ -451,6 +451,7 @@ struct trace_pid_list *trace_pid_list_alloc(void)
 
 /**
  * trace_pid_list_free - Frees an allocated pid_list.
+ * @pid_list: The pid list to free.
  *
  * Frees the memory for a pid_list that was allocated.
  */