Re: sched: Update kerneldoc for sched_rr_get_interval()

[Randy Dunlap]

On 12/11/2017 02:56 PM, Jonathan Corbet wrote:
> 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@xxxxxxx>

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.  :)

> ---
>  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)
> 


-- 
~Randy