linux-kernel - Re: [PATCH v3 53/56] shed: fix kernel-doc markup

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20201026110712.2f9cec69@coco.lan>
Date:   Mon, 26 Oct 2020 11:07:12 +0100
From:   Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
To:     Steven Rostedt <rostedt@...dmis.org>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        "Jonathan Corbet" <corbet@....net>,
        Ben Segall <bsegall@...gle.com>,
        Daniel Bristot de Oliveira <bristot@...hat.com>,
        Dietmar Eggemann <dietmar.eggemann@....com>,
        Ingo Molnar <mingo@...hat.com>,
        Juri Lelli <juri.lelli@...hat.com>,
        Mel Gorman <mgorman@...e.de>,
        Peter Zijlstra <peterz@...radead.org>,
        Vincent Guittot <vincent.guittot@...aro.org>,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v3 53/56] shed: fix kernel-doc markup

Em Fri, 23 Oct 2020 13:53:41 -0400
Steven Rostedt <rostedt@...dmis.org> escreveu:

> On Fri, 23 Oct 2020 18:33:40 +0200
> Mauro Carvalho Chehab <mchehab+huawei@...nel.org> 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.
	 */