Skip to contentSkip to conversation

sched: fix kernel-doc function parameter name

PATCH In review Randy Dunlap 1 participant 2 messages Nov 6, 2009 – Nov 8, 2009

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sched: fix kernel-doc function parameter name

From: Randy Dunlap <[email protected]>

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'

---
 kernel/sched.c |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/sched.c +1 -1
@@ -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(),
#1 lore raw

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

Commit-ID:  968c86458a5975efa7a95f832a4ec9fb21471137
Gitweb:     http://git.kernel.org/tip/968c86458a5975efa7a95f832a4ec9fb21471137
Author:     Randy Dunlap <[email protected]>
AuthorDate: Fri, 6 Nov 2009 15:31:08 -0800
Committer:  Ingo Molnar <[email protected]>
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'

LKML-Reference: <[email protected]>

---
 kernel/sched.c |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)
kernel/sched.c +1 -1
index 28dd4f4..7d7d5fc 100644
@@ -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(),