Skip to contentSkip to conversation

cpusets: cleanup kernel-doc

PATCH In review Miao Xie 3 participants 4 messages May 30, 2008

lore
Share & tools
lore

Miao Xie

author
#0 lore raw

PATCH 1/3 cpusets: cleanup kernel-doc

1. Use '/*' instead of '/**' for static functions.
2. Remove redundant blank line.

Signed-off-by Miao Xie <[email protected]>
---
 kernel/cpuset.c |   11 +++++------
 1 files changed, 5 insertions(+), 6 deletions(-)
kernel/cpuset.c +5 -6
index 86ea9e3..f063368 100644
@@ -731,7 +731,7 @@ static inline int started_after(void *p1, void *p2)
 	return started_after_time(t1, &t2->start_time, t2);
 }
 
-/**
+/*
  * cpuset_test_cpumask - test a task's cpus_allowed versus its cpuset's
  * @tsk: task to test
  * @scan: struct cgroup_scanner contained in its struct cpuset_hotplug_scanner

@@ -748,7 +748,7 @@ static int cpuset_test_cpumask(struct task_struct *tsk,
 			(cgroup_cs(scan->cg))->cpus_allowed);
 }
 
-/**
+/*
  * cpuset_change_cpumask - make a task's cpus_allowed the same as its cpuset's
  * @tsk: task to test
  * @scan: struct cgroup_scanner containing the cgroup of the task

@@ -765,7 +765,7 @@ static void cpuset_change_cpumask(struct task_struct *tsk,
 	set_cpus_allowed_ptr(tsk, &((cgroup_cs(scan->cg))->cpus_allowed));
 }
 
-/**
+/*
  * update_cpumask - update the cpus_allowed mask of a cpuset and all tasks in it
  * @cs: the cpuset to consider
  * @buf: buffer of cpu numbers written to this cpuset

@@ -1736,7 +1736,7 @@ int __init cpuset_init(void)
 	return 0;
 }
 
-/**
+/*
  * cpuset_do_move_task - move a given task to another cpuset
  * @tsk: pointer to task_struct the task to move
  * @scan: struct cgroup_scanner contained in its struct cpuset_hotplug_scanner

@@ -1753,7 +1753,7 @@ static void cpuset_do_move_task(struct task_struct *tsk,
 	cgroup_attach_task(chsp->to, tsk);
 }
 
-/**
+/*
  * move_member_tasks_to_cpuset - move tasks from one cpuset to another
  * @from: cpuset in which the tasks currently reside
  * @to: cpuset to which the tasks will be moved

@@ -1938,7 +1938,6 @@ void __init cpuset_init_smp(void)
 }
 
 /**
-
  * cpuset_cpus_allowed - return cpus_allowed mask from a tasks cpuset.
  * @tsk: pointer to task_struct from which to obtain cpuset->cpus_allowed.
  * @pmask: pointer to cpumask_t variable to receive cpus_allowed set.
Signature · 1 line
1.5.4.rc3
#2 lore raw
In reply to Miao Xie
Quoted 4 lines · On Fri, 30 May 2008 15:32:04 +0800 Miao Xie <[email protected]> wrote:

1. Use '/*' instead of '/**' for static functions.
2. Remove redundant blank line.

Signed-off-by Miao Xie <[email protected]>

NAK. These are not redundant, they are used to pull documentation out of the tree using kernel-doc or other tools that know how to finish entries out for both inline and non-inlines.

Alan

#3 lore raw
Quoted 1 line

These are not redundant

Miao wasn't saying the kernel-doc '/**' markers were redundant.

He was saying that, in one case, there was a redundant blank line, right in the middle of a kernel-doc comment, that broke that particular kernel-doc formatting.

That one-line fix is still worth getting in, though probably not worth a patch all by itself.

The NAK by Alan of the rest of this patch still applies.

Thanks, Alan, Randy and Miao.

Signature · 3 lines
                  I won't rest till it's the best ...
                  Programmer, Linux Scalability
                  Paul Jackson <[email protected]> 1.940.382.4214