linux-kernel - Re: [PATCH 1/9] hrtimer: Use a bullet for the returns bullet list

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 for Android: free password hash cracker in your pocket

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

Date:   Fri, 28 Jun 2019 10:03:05 -0300
From:   Mauro Carvalho Chehab <mchehab+samsung@...nel.org>
To:     Joe Perches <joe@...ches.com>
Cc:     Linux Doc Mailing List <linux-doc@...r.kernel.org>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        linux-kernel@...r.kernel.org, Jonathan Corbet <corbet@....net>,
        Thomas Gleixner <tglx@...utronix.de>
Subject: Re: [PATCH 1/9] hrtimer: Use a bullet for the returns bullet list

Em Fri, 28 Jun 2019 05:39:25 -0700
Joe Perches <joe@...ches.com> escreveu:

> On Fri, 2019-06-28 at 09:12 -0300, Mauro Carvalho Chehab 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@...nel.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..5ee77f1a8a92 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  
> 
> I think this last line should be indented 3 more spaces too

That would produce a warning, and will change the font for the content of 
the first line to bold. 

ReST is pedantic with whitespaces, as it uses it to identify continuation
lines.

For it to consider one line as a continuation of the previous one, the texts
on both lines (after markups) should start at the same place.

So, on:

	* foo
	  bar

"bar" is considered a continuation of the first line. So, identical to:

	* foo bar

But:

	* foo bar
	      foobar

the whitespace doesn't match. it will change the font for the first line
to bold, and place foobar on a separate line.


(yeah, I know that, for kernel-doc, this sucks)


Thanks,
Mauro