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

[Darren Hart]

On Fri, May 12, 2017 at 06:51:50PM -0300, Mauro Carvalho Chehab wrote:
> Em Fri, 12 May 2017 09:41:22 -0700
> Darren Hart <dvhart@xxxxxxxxxxxxx> 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@xxxxxxxxxxxxxxxx>  
> > 
> > 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
> 

Thanks, my search turned up a much shorter list of "list" special characters.

> > 
> > > @@ -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.

Definitely agreed. - is preferable if it renders the same.

Thanks,

-- 
Darren Hart
VMware Open Source Technology Center