[PATCH] exit: document sched_process_exit and sched_process_template relation

[PATCH] exit: document sched_process_exit and sched_process_template relation

[Andrii Nakryiko]

Add an explicit note pointing out that sched_process_exit tracepoint is,
conceptually, related to sched_process_template and should be kept in
sync (though, on the best effort basis).

This is a follow-up to [0], and can hopefully be just folded in when applying.

  [0] https://lore.kernel.org/linux-trace-kernel/20250402180925.90914-1-andrii@kernel.org/

Suggested-by: Ingo Molnar <mingo@kernel.org>
Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
---
 include/trace/events/sched.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/include/trace/events/sched.h b/include/trace/events/sched.h
index 05a14f2b35c3..3bec9fb73a36 100644
--- a/include/trace/events/sched.h
+++ b/include/trace/events/sched.h
@@ -326,7 +326,11 @@ DEFINE_EVENT(sched_process_template, sched_process_free,
 	     TP_ARGS(p));
 
 /*
- * Tracepoint for a task exiting:
+ * Tracepoint for a task exiting.
+ * Note, it's a superset of sched_process_template and should be kept
+ * compatible as much as possible. sched_process_exits has an extra
+ * `group_dead` argument, so sched_process_template can't be used,
+ * unfortunately, just like sched_migrate_task above.
  */
 TRACE_EVENT(sched_process_exit,
 
-- 
2.47.1

Re: [PATCH] exit: document sched_process_exit and sched_process_template relation

[Ingo Molnar]

* Andrii Nakryiko <andrii@kernel.org> wrote:

> Add an explicit note pointing out that sched_process_exit tracepoint is,
> conceptually, related to sched_process_template and should be kept in
> sync (though, on the best effort basis).
> 
> This is a follow-up to [0], and can hopefully be just folded in when applying.
> 
>   [0] https://lore.kernel.org/linux-trace-kernel/20250402180925.90914-1-andrii@kernel.org/
> 
> Suggested-by: Ingo Molnar <mingo@kernel.org>
> Signed-off-by: Andrii Nakryiko <andrii@kernel.org>
> ---
>  include/trace/events/sched.h | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
> 
> diff --git a/include/trace/events/sched.h b/include/trace/events/sched.h
> index 05a14f2b35c3..3bec9fb73a36 100644
> --- a/include/trace/events/sched.h
> +++ b/include/trace/events/sched.h
> @@ -326,7 +326,11 @@ DEFINE_EVENT(sched_process_template, sched_process_free,
>  	     TP_ARGS(p));
>  
>  /*
> - * Tracepoint for a task exiting:
> + * Tracepoint for a task exiting.
> + * Note, it's a superset of sched_process_template and should be kept
> + * compatible as much as possible. sched_process_exits has an extra
> + * `group_dead` argument, so sched_process_template can't be used,
> + * unfortunately, just like sched_migrate_task above.

Thanks, I've folded this into the tracepoint patch, with this small edit:

 s/sched_process_exits
  /sched_process_exit

	Ingo