Skip to contentSkip to conversation

sched/core: Fix some documentation build warnings

PATCH New Jonathan Corbet 2 participants 2 messages Jul 24, 2017 – Jul 25, 2017 Scheduler

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 sched/core: Fix some documentation build warnings

The kerneldoc comments for try_to_wake_up_local() were out of date, leading to these documentation build warnings:

./kernel/sched/core.c:2080: warning: No description found for parameter 'rf' ./kernel/sched/core.c:2080: warning: Excess function parameter 'cookie' description in 'try_to_wake_up_local'

Update the comment to reflect current reality and give us some peace and quiet.

---
 kernel/sched/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/sched/core.c +1 -1
index 17c667b427b4..0869b20fba81 100644
@@ -2069,7 +2069,7 @@ try_to_wake_up(struct task_struct *p, unsigned int state, int wake_flags)
 /**
  * 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
+ * @rf: request-queue flags 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
Signature · 1 line
2.9.4
#1 lore raw
sched/core: Fix some documentation build warnings
Commit-ID:  bf50f0e8a03005d19de66d01261d855cdeedf572
Gitweb:     http://git.kernel.org/tip/bf50f0e8a03005d19de66d01261d855cdeedf572
Author:     Jonathan Corbet <[email protected]>
AuthorDate: Mon, 24 Jul 2017 13:56:28 -0600
Committer:  Ingo Molnar <[email protected]>
CommitDate: Tue, 25 Jul 2017 11:17:02 +0200

sched/core: Fix some documentation build warnings

The kerneldoc comments for try_to_wake_up_local() were out of date, leading to these documentation build warnings:

./kernel/sched/core.c:2080: warning: No description found for parameter 'rf' ./kernel/sched/core.c:2080: warning: Excess function parameter 'cookie' description in 'try_to_wake_up_local'

Update the comment to reflect current reality and give us some peace and quiet.

---
 kernel/sched/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
kernel/sched/core.c +1 -1
index 17c667b..0869b20 100644
@@ -2069,7 +2069,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
+ * @rf: request-queue flags 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