lkml.org 
[lkml]   [2019]   [Jun]   [23]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 4/6] time: hrtimer: use a bullet for the returns bullet list
On Thu, 20 Jun 2019, Mauro Carvalho Chehab wrote:
> Em Thu, 20 Jun 2019 14:02:33 -0600
> Jonathan Corbet <corbet@lwn.net> escreveu:
> > On Tue, 18 Jun 2019 15:51:20 -0300
> > Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> > > * Returns:
> > > - * 0 when the timer was not active
> > > - * 1 when the timer was active
> > > - * -1 when the timer is currently executing the callback function and
> > > + *
> > > + * • 0 when the timer was not active
> > > + * • 1 when the timer was active
> > > + * • -1 when the timer is currently executing the callback function and
> > > * cannot be stopped
> >
> > So I have taken some grief for letting non-ASCII stuff into the docs
> > before; I can only imagine that those who object would be even more
> > unhappy to see it in a C source file. I'm all for fixing the warning, but
> > I think we shouldn't start introducing exotic characters at this point...
>
> According to:
> http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists
>
> The ASCII options are: "-", "+" or "*".
>
> Both signs ('-' and '+') aren't too nice here, due to "-1".
>
> So, what's left is '*'.
>
> I remember someone once complained about having something like:
>
> * * -1 when the ...

I'm fine with that.

> But if you think we shouldn't use UTF-8 chars, be it.

I don't even know how to write them in the first place.

> Feel free to replace it at the patch, or if you prefer, I'll send a new
> version tomorrow.

Yes, please.

And while at it please fix the subject line. The usual prefix for hrtimer
is surprisingly 'hrtimer:' and not 'time: hrtimer:'. Also please start the
short sentence after the prefix with an uppercase character.

Thanks,

tglx
\
 
 \ /
  Last update: 2019-06-23 12:32    [W:0.059 / U:0.372 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site