Skip to contentSkip to conversation

sched: fix yield_to kernel-doc

PATCH In review Randy Dunlap 1 participant 2 messages Mar 18, 2011 – Mar 19, 2011

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sched: fix yield_to kernel-doc

From: Randy Dunlap <[email protected]>

Add missing function parameters for yield_to():

Warning(kernel/sched.c:5470): No description found for parameter 'p' Warning(kernel/sched.c:5470): No description found for parameter 'preempt'

Cc Ingo Molnar <[email protected]>
Cc Peter Zijlstra <[email protected]>

---
Corrections needed?

 kernel/sched.c |    2 ++
 1 file changed, 2 insertions(+)
kernel/sched.c +2 -0
@@ -5460,6 +5460,8 @@ EXPORT_SYMBOL(yield);
  * yield_to - yield the current processor to another thread in
  * your thread group, or accelerate that thread toward the
  * processor it's on.
+ * @p: target task
+ * @preempt: whether task preemption is allowed or not
  *
  * It's the caller's job to ensure that the target task struct
  * can't go away on us before we can do any checks.
#1 lore raw

[tip:sched/urgent] sched: Fix yield_to kernel-doc

Commit-ID:  16addf954d3954a72fd56abc02ffcba3c18529a1
Gitweb:     http://git.kernel.org/tip/16addf954d3954a72fd56abc02ffcba3c18529a1
Author:     Randy Dunlap <[email protected]>
AuthorDate: Fri, 18 Mar 2011 09:34:53 -0700
Committer:  Ingo Molnar <[email protected]>
CommitDate: Sat, 19 Mar 2011 19:19:36 +0100

sched: Fix yield_to kernel-doc

Add missing function parameters for yield_to():

Warning(kernel/sched.c:5470): No description found for parameter 'p' Warning(kernel/sched.c:5470): No description found for parameter 'preempt'

Cc Peter Zijlstra <[email protected]>

LKML-Reference: <[email protected]>

---
 kernel/sched.c |    2 ++
 1 files changed, 2 insertions(+), 0 deletions(-)
kernel/sched.c +2 -0
index 58d66ea..052120d 100644
@@ -5467,6 +5467,8 @@ EXPORT_SYMBOL(yield);
  * yield_to - yield the current processor to another thread in
  * your thread group, or accelerate that thread toward the
  * processor it's on.
+ * @p: target task
+ * @preempt: whether task preemption is allowed or not
  *
  * It's the caller's job to ensure that the target task struct
  * can't go away on us before we can do any checks.