[PATCH] cpuset: Add comments for update_domain_attr_tree

[PATCH] cpuset: Add comments for update_domain_attr_tree

[Lai Jiangshan]

Add comments for update_domain_attr_tree().

Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com>
---
diff --git a/kernel/cpuset.c b/kernel/cpuset.c
index adf66c0..fed1f42 100644
--- a/kernel/cpuset.c
+++ b/kernel/cpuset.c
@@ -487,15 +487,21 @@ update_domain_attr(struct sched_domain_attr *dattr, struct cpuset *c)
 {
 	if (dattr->relax_domain_level < c->relax_domain_level)
 		dattr->relax_domain_level = c->relax_domain_level;
-	return;
 }
 
+/*
+ * Helper routine for rebuild_sched_domains().
+ * Walk the specified cpuset subtree and update @dattr with the
+ * largest relax_domain_level.
+ *
+ * Called with cgroup_mutex held.
+ */
 static void
-update_domain_attr_tree(struct sched_domain_attr *dattr, struct cpuset *c)
+update_domain_attr_tree(struct sched_domain_attr *dattr, struct cpuset *root)
 {
 	LIST_HEAD(q);
 
-	list_add(&c->stack_list, &q);
+	list_add(&root->stack_list, &q);
 	while (!list_empty(&q)) {
 		struct cpuset *cp;
 		struct cgroup *cont;

Re: [PATCH] cpuset: Add comments for update_domain_attr_tree

[Lai Jiangshan]

This patch was reviewed by Li Zefan and was revised on his suggestion before sent.
Thanks Li Zefan.

Reviewed-by: Li Zefan <lizf@cn.fujitsu.com>

Lai Jiangshan wrote:
> Add comments for update_domain_attr_tree().
> 
> Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com>
> ---
> diff --git a/kernel/cpuset.c b/kernel/cpuset.c
> index adf66c0..fed1f42 100644
> --- a/kernel/cpuset.c
> +++ b/kernel/cpuset.c
> @@ -487,15 +487,21 @@ update_domain_attr(struct sched_domain_attr *dattr, struct cpuset *c)
>  {
>  	if (dattr->relax_domain_level < c->relax_domain_level)
>  		dattr->relax_domain_level = c->relax_domain_level;
> -	return;
>  }
>  
> +/*
> + * Helper routine for rebuild_sched_domains().
> + * Walk the specified cpuset subtree and update @dattr with the
> + * largest relax_domain_level.
> + *
> + * Called with cgroup_mutex held.
> + */
>  static void
> -update_domain_attr_tree(struct sched_domain_attr *dattr, struct cpuset *c)
> +update_domain_attr_tree(struct sched_domain_attr *dattr, struct cpuset *root)
>  {
>  	LIST_HEAD(q);
>  
> -	list_add(&c->stack_list, &q);
> +	list_add(&root->stack_list, &q);
>  	while (!list_empty(&q)) {
>  		struct cpuset *cp;
>  		struct cgroup *cont;
> 
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
> Please read the FAQ at  http://www.tux.org/lkml/
> 
> 
> 


-- 
业精于勤荒于嬉

Re: [PATCH] cpuset: Add comments for update_domain_attr_tree

[Paul Menage]

On Thu, Jul 31, 2008 at 12:42 AM, Lai Jiangshan <laijs@cn.fujitsu.com> wrote:
>
> This patch was reviewed by Li Zefan and was revised on his suggestion before sent.
> Thanks Li Zefan.
>
> Reviewed-by: Li Zefan <lizf@cn.fujitsu.com>
>
> Lai Jiangshan wrote:
>> Add comments for update_domain_attr_tree().
>>
>> Signed-off-by: Lai Jiangshan <laijs@cn.fujitsu.com>
>> ---
>> diff --git a/kernel/cpuset.c b/kernel/cpuset.c
>> index adf66c0..fed1f42 100644
>> --- a/kernel/cpuset.c
>> +++ b/kernel/cpuset.c
>> @@ -487,15 +487,21 @@ update_domain_attr(struct sched_domain_attr *dattr, struct cpuset *c)
>>  {
>>       if (dattr->relax_domain_level < c->relax_domain_level)
>>               dattr->relax_domain_level = c->relax_domain_level;
>> -     return;
>>  }
>>
>> +/*

If you're going to add a comment block, maybe it's worth making it
docbook-compatible? So /** at the start, and then following the proper
docbook style conventions in kernel-doc-nano-HOWTO.txt ?

Paul