lkml.org 
[lkml]   [2018]   [Feb]   [15]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
SubjectRe: [PATCH-next] sched/headers: Clean up <linux/sched.h>
From
Date
Hi Peter, thanks for the reply.


El jue, 15-02-2018 a las 17:52 +0100, Peter Zijlstra escribió:
> On Thu, Feb 15, 2018 at 10:43:18AM -0500, Christopher Diaz Riveros
> wrote:
> > @@ -183,7 +183,7 @@ extern void io_schedule_finish(int token);
> > extern long io_schedule_timeout(long timeout);
> > extern void io_schedule(void);
> >
> > -/**
> > +/*
> > * struct prev_cputime - snapshot of system and user cputime
> > * @utime: time spent in user mode
> > * @stime: time spent in system mode
> > @@ -200,7 +200,7 @@ struct prev_cputime {
> > #endif
> > };
> >
> > -/**
> > +/*
> > * struct task_cputime - collected CPU time counts
> > * @utime: time spent in user mode, in nanoseconds
> > * @stime: time spent in kernel mode, in
> > nanoseconds
>
> Why, are those not valid kerneldoc comments?

Following the same structure from most of the multiline comments in the
file, they tend to be

/*
*
*/

I thought it was a typo, and maybe this makes the whole file have a
uniform multiline comment style.

>
> > @@ -437,20 +437,28 @@ struct sched_dl_entity {
> > * during sched_setattr(), they will remain the same until
> > * the next sched_setattr().
> > */
> > - u64 dl_runtime; /*
> > Maximum runtime for each instance */
> > - u64 dl_deadline; /*
> > Relative deadline of each instance */
> > - u64 dl_period; /*
> > Separation of two instances (period) */
> > - u64 dl_bw; /
> > * dl_runtime / dl_period */
> > - u64 dl_density; /*
> > dl_runtime / dl_deadline */
> > + /* Maximum runtime for each instance */
> > + u64 dl_runtime;
> > + /* Relative deadline of each instance */
> > + u64 dl_deadline;
> > + /* Separation of two instances (period) */
> > + u64 dl_period;
> > + /* dl_runtime / dl_period */
> > + u64 dl_bw;
> > + /* dl_runtime / dl_deadline */
> > + u64 dl_density;
>
> That's a whole lot less readable :/

Well, while reading the file on a 80 columns width terminal, it breaks
lines producing results like:

/* Maximum runtime for e
ach instance */

/* dl_runtime / dl_deadl
ine */

among others.

In fact, most of the comments in the file follow the structure:

/* comment about var */
type identifier

You can see this structure in lines:

631
689
740
781
820
among others.

--
Christopher Díaz Riveros
Gentoo Linux Developer
GPG Fingerprint: E517 5ECB 8152 98E4 FEBC 2BAA 4DBB D10F 0FDD 2547

\
 
 \ /
  Last update: 2018-02-15 18:11    [W:0.121 / U:0.176 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site