linux-kernel - [PATCH] sched: core.c: Fix outdated comments

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:   Tue, 28 Mar 2017 21:32:26 +0300
From:   Tamara Diaconita <diaconitatamara@...il.com>
To:     mingo@...hat.com, peterz@...radead.org,
        linux-kernel@...r.kernel.org, outreachy-kernel@...glegroups.com,
        corbet@....net
Cc:     Tamara Diaconita <diaconita.tamara@...il.com>
Subject: [PATCH] sched: core.c: Fix outdated comments

In d8ac897137a2 (sched/core: Add wrappers for lockdep_(un)pin_lock()), 
the prototype for try_to_wake_up local() was changed, but the kerneldoc 
comment was not updated, resulting in these warnings in the documentation 
build:

.kernel/sched/core.c:2085: warning: Excess function parameter 'cookie'  description in 'try_to_wake_up_local'

.kernel/sched/core.c:2085: warning: No description found for parameter 'rf'

Update the comment to match the new 'rf' parameter.

Fixes: d8ac897137a230ec351269f6378017f2decca512
Signed-off-by: Tamara Diaconita <diaconita.tamara@...il.com>
---
 kernel/sched/core.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/kernel/sched/core.c b/kernel/sched/core.c
index 9563838..0d03755 100644
--- a/kernel/sched/core.c
+++ b/kernel/sched/core.c
@@ -2074,7 +2074,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: runqueue flags
  *
  * 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.9.3