lkml.org 
[lkml]   [2019]   [Jun]   [20]   [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
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:
>
> > That gets rid of this warning:
> >
> > ./kernel/time/hrtimer.c:1119: WARNING: Block quote ends without a blank line; unexpected unindent.
> >
> > and displays nicely both at the source code and at the produced
> > documentation.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> > kernel/time/hrtimer.c | 7 ++++---
> > 1 file changed, 4 insertions(+), 3 deletions(-)
> >
> > diff --git a/kernel/time/hrtimer.c b/kernel/time/hrtimer.c
> > index edb230aba3d1..49f78453892f 100644
> > --- a/kernel/time/hrtimer.c
> > +++ b/kernel/time/hrtimer.c
> > @@ -1114,9 +1114,10 @@ EXPORT_SYMBOL_GPL(hrtimer_start_range_ns);
> > * @timer: hrtimer to stop
> > *
> > * 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 ...

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

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

Thanks,
Mauro

\
 
 \ /
  Last update: 2019-06-20 22:17    [W:0.044 / U:0.644 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site