[PATCH] sched: fix kernel-doc function parameter name

[PATCH] sched: fix kernel-doc function parameter name

[Randy Dunlap]

From: Randy Dunlap <randy.dunlap@oracle.com>

Fix variable name in sched.c kernel-doc notation.

Warning(kernel/sched.c:2008): No description found for parameter 'p'
Warning(kernel/sched.c:2008): Excess function parameter 'k' description in 'kthread_bind'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 kernel/sched.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-2.6.32-rc6-git3.orig/kernel/sched.c
+++ linux-2.6.32-rc6-git3/kernel/sched.c
@@ -1994,7 +1994,7 @@ static inline void check_class_changed(s
 
 /**
  * kthread_bind - bind a just-created kthread to a cpu.
- * @k: thread created by kthread_create().
+ * @p: thread created by kthread_create().
  * @cpu: cpu (might not be online, must be possible) for @k to run on.
  *
  * Description: This function is equivalent to set_cpus_allowed(),

[tip:sched/urgent] sched: Fix kernel-doc function parameter name

[tip-bot for Randy Dunlap]

Commit-ID:  968c86458a5975efa7a95f832a4ec9fb21471137
Gitweb:     http://git.kernel.org/tip/968c86458a5975efa7a95f832a4ec9fb21471137
Author:     Randy Dunlap <randy.dunlap@oracle.com>
AuthorDate: Fri, 6 Nov 2009 15:31:08 -0800
Committer:  Ingo Molnar <mingo@elte.hu>
CommitDate: Sun, 8 Nov 2009 11:26:25 +0100

sched: Fix kernel-doc function parameter name

Fix variable name in sched.c kernel-doc notation.

Fixes this DocBook warning:

 Warning(kernel/sched.c:2008): No description found for parameter
 'p' Warning(kernel/sched.c:2008): Excess function parameter 'k'
 description in 'kthread_bind'

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
LKML-Reference: <4AF4B1BC.8020604@oracle.com>
Signed-off-by: Ingo Molnar <mingo@elte.hu>
---
 kernel/sched.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/kernel/sched.c b/kernel/sched.c
index 28dd4f4..7d7d5fc 100644
--- a/kernel/sched.c
+++ b/kernel/sched.c
@@ -1994,7 +1994,7 @@ static inline void check_class_changed(struct rq *rq, struct task_struct *p,
 
 /**
  * kthread_bind - bind a just-created kthread to a cpu.
- * @k: thread created by kthread_create().
+ * @p: thread created by kthread_create().
  * @cpu: cpu (might not be online, must be possible) for @k to run on.
  *
  * Description: This function is equivalent to set_cpus_allowed(),