comment "ptrace_list" and "children" members

comment "ptrace_list" and "children" members

[David Mosberger]

A while ago I had a "fun" time sorting out how the "ptrace_children"
and the "children" lists are being used.  I think the two little
comments would help making that process a lot easier (they're based on
an earlier email by Roland).

	--david

Document the purpose of the "ptrace_list/ptrace_children" and
"children/sibling" lists.

Signed-off-by: davidm@hpl.hp.com

===== include/linux/sched.h 1.179 vs edited =====
--- 1.179/include/linux/sched.h	2004-07-06 22:19:25 -07:00
+++ edited/include/linux/sched.h	2004-07-20 21:57:10 -07:00
@@ -410,6 +410,10 @@
 	unsigned int time_slice, first_time_slice;
 
 	struct list_head tasks;
+	/*
+	 * ptrace_list/ptrace_children forms the list of my children
+	 * that were stolen by a ptracer.
+	 */
 	struct list_head ptrace_children;
 	struct list_head ptrace_list;
 
@@ -431,6 +435,10 @@
 	 */
 	struct task_struct *real_parent; /* real parent process (when being debugged) */
 	struct task_struct *parent;	/* parent process */
+	/*
+	 * children/sibling forms the list of my children plus the
+	 * tasks I'm ptracing.
+	 */
 	struct list_head children;	/* list of my children */
 	struct list_head sibling;	/* linkage in my parent's children list */
 	struct task_struct *group_leader;	/* threadgroup leader */

Re: comment "ptrace_list" and "children" members

[Roland McGrath]

> A while ago I had a "fun" time sorting out how the "ptrace_children"
> and the "children" lists are being used.  I think the two little
> comments would help making that process a lot easier (they're based on
> an earlier email by Roland).

Last time I debugged a ptrace-related bug, I too spent a good little while
going in circles because I couldn't keep track from day to day how those
lists were being used.  Those comments would help at least some.


Thanks,
Roland