Em Fri, 23 Oct 2020 13:53:41 -0400 Steven Rostedt <rostedt@xxxxxxxxxxx> escreveu: > 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. Agreed, but there are already some other descriptions over there that have multiple lines[1]: Anyway, on this specific case, I guess it can be easily shorten to 80 columns without losing anything. Would that work for you? /** * cpu_util - Estimates the amount of capacity of a CPU used by CFS tasks. Regards, Mauro [1] like this one: /** * calculate_imbalance - Calculate the amount of imbalance present within the * groups of a given sched_domain during load balance. * @env: load balance environment * @sds: statistics of the sched_domain whose imbalance is to be calculated. */
