Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > linux.kernel > #1640779

Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST

Show all headers | View raw

Em Fri, 12 May 2017 09:41:22 -0700
Darren Hart <dvhart@infradead.org> escreveu:

> On Fri, May 12, 2017 at 10:59:47AM -0300, Mauro Carvalho Chehab wrote:
> > There are a few issues on some kernel-doc markups that was
> > causing troubles with kernel-doc output on ReST format.
> > Fix them.
> > 
> > No functional changes.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>  
> 
> No objection. One question, rather than prefixing the bulleted list of return
> codes with a "-" which has no ReST meaning I could find, should we use "*"
> instead which would be converted to a bullet it formatted documentation?

At least on Sphinx[1]:
	"A text block which begins with a "*", "+", "-", "•", "‣", or "⁃",
	 followed by whitespace, is a bullet list item"

I never tried "+", but both "-" and "*" produce the same visual.

[1] http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#bullet-lists

> 
> > @@ -1259,9 +1259,9 @@ static int lock_pi_update_atomic(u32 __user *uaddr, u32 uval, u32 newval)
> >   * @set_waiters:	force setting the FUTEX_WAITERS bit (1) or not (0)
> >   *
> >   * Return:
> > - *  0 - ready to wait;
> > - *  1 - acquired the lock;
> > - * <0 - error
> > + *  -  0 - ready to wait;
> > + *  -  1 - acquired the lock;
> > + *  - <0 - error
> >   *  
> 
> e.g.
> 
>  * Return:
>  *  *  0 - ready to wait
>  *  *  1 - acquired the lock
>  *  * <0 - error
> 
> I'm fine with either though, just curious if this would be an improvement, or if
> we have an established policy (which I didn't find in the docs on docs...).

I prefer myself to use "-". IMHO, a dash is visually less polluted
than an asterisk, when reading text files, but I guess this is a
matter of taste.

> Acked-by: Darren Hart (VMware) <dvhart@infradead.org>

Thanks,
Mauro

Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-12 16:10 +0200
  Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-12 18:50 +0200
    Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-13 00:00 +0200
      Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-13 00:20 +0200
        Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-13 11:50 +0200
        Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Peter Zijlstra <peterz@infradead.org> - 2017-05-15 09:10 +0200
          Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-15 11:10 +0200
            Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Peter Zijlstra <peterz@infradead.org> - 2017-05-15 11:40 +0200
              Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST Jani Nikula <jani.nikula@linux.intel.com> - 2017-05-15 12:30 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Peter Zijlstra <peterz@infradead.org> - 2017-05-15 13:50 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to generate ReST Jani Nikula <jani.nikula@linux.intel.com> - 2017-05-15 14:10 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-15 18:50 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 12:20 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-15 19:30 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Peter Zijlstra <peterz@infradead.org> - 2017-05-16 13:20 +0200
                Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 13:50 +0200
      Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-13 00:20 +0200
      Re: [PATCH 04/36] mutex, futex: adjust kernel-doc markups to  generate ReST Peter Zijlstra <peterz@infradead.org> - 2017-05-13 00:20 +0200

csiph-web