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 <[email protected]>
---
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
*/
int hrtimer_try_to_cancel(struct hrtimer *timer)
--
2.21.0
On Tue, 18 Jun 2019 15:51:20 -0300
Mauro Carvalho Chehab <[email protected]> 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 <[email protected]>
> ---
> 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...
Thanks,
jon
> */
> int hrtimer_try_to_cancel(struct hrtimer *timer)
Em Thu, 20 Jun 2019 14:02:33 -0600
Jonathan Corbet <[email protected]> escreveu:
> On Tue, 18 Jun 2019 15:51:20 -0300
> Mauro Carvalho Chehab <[email protected]> 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 <[email protected]>
> > ---
> > 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
On Thu, 20 Jun 2019, Mauro Carvalho Chehab wrote:
> Em Thu, 20 Jun 2019 14:02:33 -0600
> Jonathan Corbet <[email protected]> escreveu:
> > On Tue, 18 Jun 2019 15:51:20 -0300
> > Mauro Carvalho Chehab <[email protected]> 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