[PATCH] sched/core: add doc for cookie argument

[PATCH] sched/core: add doc for cookie argument

[Luis de Bethencourt]

Add documentation for the cookie argument in try_to_wake_up_local()

This caused the following warning when building documentation:
kernel/sched/core.c:2088: warning: No description found for parameter 'cookie'

Fixes: e7904a28f533 ("ilocking/lockdep, sched/core: Implement a better lock pinning scheme")

Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
---
 kernel/sched/core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/kernel/sched/core.c b/kernel/sched/core.c
index 8c642cc..1f35e8c 100644
--- a/kernel/sched/core.c
+++ b/kernel/sched/core.c
@@ -2079,6 +2079,7 @@ out:
 /**
  * try_to_wake_up_local - try to wake up a local task with rq lock held
  * @p: the thread to be awakened
+ * @cookie: context's cookie for pinning
  *
  * Put @p on the run-queue if it's not already there. The caller must
  * ensure that this_rq() is locked, @p is bound to this_rq() and not
-- 
2.5.1

[tip:sched/core] sched/core: Add documentation for 'cookie' argument

[tip-bot for Luis de Bethencourt]

Commit-ID:  9279e0d2e565e0217618c2087de83d3239811329
Gitweb:     http://git.kernel.org/tip/9279e0d2e565e0217618c2087de83d3239811329
Author:     Luis de Bethencourt <luisbg@osg.samsung.com>
AuthorDate: Sun, 10 Jul 2016 15:00:26 +0100
Committer:  Ingo Molnar <mingo@kernel.org>
CommitDate: Wed, 10 Aug 2016 14:03:32 +0200

sched/core: Add documentation for 'cookie' argument

Add documentation for the cookie argument in try_to_wake_up_local().

This caused the following warning when building documentation:

  kernel/sched/core.c:2088: warning: No description found for parameter 'cookie'

Signed-off-by: Luis de Bethencourt <luisbg@osg.samsung.com>
Signed-off-by: Peter Zijlstra (Intel) <peterz@infradead.org>
Cc: Linus Torvalds <torvalds@linux-foundation.org>
Cc: Mike Galbraith <efault@gmx.de>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Thomas Gleixner <tglx@linutronix.de>
Cc: akpm@linux-foundation.org
Fixes: e7904a28f533 ("ilocking/lockdep, sched/core: Implement a better lock pinning scheme")
Link: http://lkml.kernel.org/r/1468159226-17674-1-git-send-email-luisbg@osg.samsung.com
Signed-off-by: Ingo Molnar <mingo@kernel.org>
---
 kernel/sched/core.c | 1 +
 1 file changed, 1 insertion(+)

diff --git a/kernel/sched/core.c b/kernel/sched/core.c
index 4a5f52e..10f2595 100644
--- a/kernel/sched/core.c
+++ b/kernel/sched/core.c
@@ -2073,6 +2073,7 @@ out:
 /**
  * try_to_wake_up_local - try to wake up a local task with rq lock held
  * @p: the thread to be awakened
+ * @cookie: context's cookie for pinning
  *
  * Put @p on the run-queue if it's not already there. The caller must
  * ensure that this_rq() is locked, @p is bound to this_rq() and not