Re: sched: Update kerneldoc for sched_rr_get_interval()

From: Jonathan Corbet
Date: Mon Dec 11 2017 - 18:25:49 EST


On Mon, 11 Dec 2017 15:14:21 -0800
Randy Dunlap <rdunlap@xxxxxxxxxxxxx> wrote:

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

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