linux-kernel - sched: Update kerneldoc for sched_rr_get

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>] [thread-next>] [day] [month] [year] [list]

Message-ID: <20171211155651.7b098034@lwn.net>
Date:   Mon, 11 Dec 2017 15:56:51 -0700
From:   Jonathan Corbet <corbet@....net>
To:     Ingo Molnar <mingo@...hat.com>,
        Peter Zijlstra <peterz@...radead.org>
Cc:     LKML <linux-kernel@...r.kernel.org>,
        Al Viro <viro@...IV.linux.org.uk>
Subject: sched: Update kerneldoc for sched_rr_get_interval()

Commit abca5fc535a3e ("sched_rr_get_interval(): move compat to native, get
rid of set_fs()") changed the prototype of that function but left the
kerneldoc comments unchanged, leading to these docs-build warnings:

  ./kernel/sched/core.c:5113: warning: No description found for parameter 't'
  ./kernel/sched/core.c:5113: warning: Excess function parameter 'interval'
  			      description in 'sched_rr_get_interval'

Update the documentation (noting that it's not a user-space address
anymore) and make the docs build a little quieter.

Signed-off-by: Jonathan Corbet <corbet@....net>
---
 kernel/sched/core.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/kernel/sched/core.c b/kernel/sched/core.c
index 75554f366fd3..a6e9edb55333 100644
--- a/kernel/sched/core.c
+++ b/kernel/sched/core.c
@@ -5100,12 +5100,12 @@ SYSCALL_DEFINE1(sched_get_priority_min, int, policy)
 /**
  * sys_sched_rr_get_interval - return the default timeslice of a process.
  * @pid: pid of the process.
- * @interval: userspace pointer to the timeslice value.
+ * @t: pointer to the timeslice value.
  *
  * this syscall writes the default timeslice value of a given process
- * into the user-space timespec buffer. A value of '0' means infinity.
+ * into the timespec64 buffer. A value of '0' means infinity.
  *
- * Return: On success, 0 and the timeslice is in @interval. Otherwise,
+ * Return: On success, 0 and the timeslice is in @t. Otherwise,
  * an error code.
  */
 static int sched_rr_get_interval(pid_t pid, struct timespec64 *t)
-- 
2.14.3