lkml.org 
[lkml]   [2016]   [Nov]   [28]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup
Em Mon, 28 Nov 2016 14:46:45 +0100
Daniel Vetter <daniel@ffwll.ch> escreveu:

> On Mon, Nov 28, 2016 at 12:54:13PM +0100, Peter Zijlstra wrote:
> > On Mon, Nov 28, 2016 at 09:08:55AM -0200, Mauro Carvalho Chehab wrote:
> > > - use *foo* (for italics) or **foo** (for bold) instead of _foo_;
> >
> > That's daft, and also you're wrong. The normal convention is:
> >
> > /italic/
> > *bold*
> > _underlined_
>
> I dont think anything is lost if we don't use the rst flavour but keep the
> traditional one. The html output meant for newbies looks a bit more funny,
> but if that means the old guard is more likely to type the docs then
> that's more than worth it.

Yep. Maybe we could later add a Sphinx extension that would add support
for /italic/ and _underlined_ traditional convention. IMHO, it was a
bad decision from Sphinx developers to not support underlined texts.

>
> > > :ref:`Documentation/admin-guide/serial-console.rst <serial_console>`
> >
> > That seems to work, as in 'gf' doesn't get confused by the spurious
> > characters attached. Is there any way to enforce that?
> >
> > > - if you have something that you want to use a monotonic font on
> > > PDF/LaTeX/HTML, use ``foo``.
> >
> > Bit weird, somewhere in the typewriter age they invented the " symbol so
> > we didn't have to type double quotes anymore.
>
> "Quote" just gives you a quote, not fixed-width. The `` noise is what
> upset Christoph, and I think it's perfectly fine to not use them.

``fixed-width`` is worse than "fixed-width", but on the other hand
it won't require to add escape codes for " character, if used on
some context where fixed width fonts is not required. So, at least for
me, ``fixed-width`` is acceptable.

Regards,
Mauro

\
 
 \ /
  Last update: 2016-11-28 16:15    [W:0.043 / U:0.664 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site