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.
--- kernel/sched/core.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)
kernel/sched/core.c +3 -3
@@ -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)
Signature · 1 line
2.14.3
Quoted 4 lines · Jonathan Corbet
Commit
abca5fc535a3e("sched_rr_get_interval(): move compat to native, get rid ofset_fs()") changed the prototype of that function but left the kerneldoc comments unchanged, leading to these docs-build warnings:
Quoted 8 lines
./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 <[email protected]>
I sent a patch for this on DEC-03 to Al, Ingo, PeterZ, and LKML.
https://marc.info/?l=linux-kernel&m=151233595424349&w=2
or I could ack your patch. :)
Quoted 25 lines
--- kernel/sched/core.c | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-)kernel/sched/core.c +3
-3@@ -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)
Signature · 1 line
~Randy
Quoted 12 lines · On Mon, 11 Dec 2017 15:14:21 -0800 Randy Dunlap <[email protected]> wrote:
Quoted 11 lines · Jonathan Corbet
Commit
abca5fc535a3e("sched_rr_get_interval(): move compat to native, get rid ofset_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.
Quoted 6 lines
Quoted 1 line
Signed-off-by Jonathan Corbet <[email protected]>I sent a patch for this on DEC-03 to Al, Ingo, PeterZ, and LKML.
https://marc.info/?l=linux-kernel&m=151233595424349&w=2or I could ack your patch. :)
OK, looking more closely, your patch is more correct than mine and is the one that should be applied. Sorry I didn't see it before.
jon
Quoted 17 lines · Jonathan Corbet
Quoted 14 lines · On Mon, 11 Dec 2017 15:14:21 -0800 Randy Dunlap <[email protected]> wrote:
Quoted 12 lines · Jonathan Corbet
Commit
abca5fc535a3e("sched_rr_get_interval(): move compat to native, get rid ofset_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 <[email protected]>
Quoted 7 lines
Quoted 4 lines
I sent a patch for this on DEC-03 to Al, Ingo, PeterZ, and LKML.
https://marc.info/?l=linux-kernel&m=151233595424349&w=2or I could ack your patch. :)
OK, looking more closely, your patch is more correct than mine and is the one that should be applied. Sorry I didn't see it before.
Yeah, I have applied Randy's patch to the sched/urgent tree yesterday:
2064a5ab0470: sched/core: Fix kernel-doc warnings after code movement
It's still not pushed out though, because I'm chasing an (unrelated) regression.
Thanks,
Ingo