On Fri, 23 Oct 2020 18:33:40 +0200 Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> wrote: > Kernel-doc requires that a kernel-doc markup to be immediatly > below the function prototype, as otherwise it will rename it. > So, move sys_sched_yield() markup to the right place. > > Also fix the cpu_util() markup: Kernel-doc markups > should use this format: > identifier - description The first change looks fine to me, but as I'm getting a new shed delivered soon, I originally thought this email was about that delivery! I do have a nit about the second change. > diff --git a/kernel/sched/fair.c b/kernel/sched/fair.c > index aa4c6227cd6d..94386fcfafcf 100644 > --- a/kernel/sched/fair.c > +++ b/kernel/sched/fair.c > @@ -6287,7 +6287,8 @@ static int select_idle_sibling(struct task_struct *p, int prev, int target) > } > > /** > - * Amount of capacity of a CPU that is (estimated to be) used by CFS tasks > + * cpu_util - Amount of capacity of a CPU that is (estimated to be) > + * used by CFS tasks The description is to be a single line. The line break is ugly, and the 80 col rule, is more of a guideline, and not something that *has* to be done. Either shorten it, or just let it go a little longer. -- Steve > * @cpu: the CPU to get the utilization of > * > * The unit of the return value must be the one of capacity so we can compare
