From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Daniel Vetter <daniel@ffwll.ch>
Cc: Peter Zijlstra <peterz@infradead.org>,
Jonathan Corbet <corbet@lwn.net>,
Silvio Fricke <silvio.fricke@gmail.com>,
linux-doc@vger.kernel.org, Ming Lei <ming.lei@canonical.com>,
"Luis R . Rodriguez" <mcgrof@kernel.org>,
Mauro Carvalho Chehab <mchehab@kernel.org>,
linux-kernel@vger.kernel.org,
Jani Nikula <jani.nikula@linux.intel.com>
Subject: Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup
Date: Mon, 28 Nov 2016 13:14:46 -0200 [thread overview]
Message-ID: <20161128131446.5e00d478@vento.lan> (raw)
In-Reply-To: <20161128134645.7jie7ph3kyxlsyvq@phenom.ffwll.local>
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
next prev parent reply other threads:[~2016-11-28 15:15 UTC|newest]
Thread overview: 51+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-24 12:42 [PATCH 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke
2016-11-24 12:42 ` [PATCH 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke
2016-11-24 12:42 ` [PATCH 2/4] Documentation/atomic_ops.txt: " Silvio Fricke
2016-11-24 12:42 ` [PATCH 3/4] Documentation/local_ops.txt: " Silvio Fricke
2016-11-24 12:42 ` [PATCH 4/4] firmware: remove warning at documentation generation time Silvio Fricke
2016-11-24 19:46 ` [PATCH 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Mauro Carvalho Chehab
2016-11-25 10:02 ` [PATCH v2 " Silvio Fricke
2016-11-25 10:02 ` [PATCH v2 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke
2016-11-25 13:03 ` Mauro Carvalho Chehab
2016-11-25 10:02 ` [PATCH v2 2/4] Documentation/atomic_ops.txt: " Silvio Fricke
2016-11-25 13:25 ` Mauro Carvalho Chehab
2016-11-25 10:02 ` [PATCH v2 3/4] Documentation/local_ops.txt: " Silvio Fricke
2016-11-25 13:34 ` Mauro Carvalho Chehab
2016-11-25 13:47 ` S. Fricke
2016-11-25 13:58 ` Mauro Carvalho Chehab
2016-11-25 10:02 ` [PATCH v2 4/4] firmware: remove warning at documentation generation time Silvio Fricke
2016-11-25 13:34 ` Mauro Carvalho Chehab
2016-11-25 14:59 ` [PATCH v3 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke
2016-11-25 14:59 ` [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke
2016-11-25 20:53 ` Mauro Carvalho Chehab
2016-11-25 14:59 ` [PATCH v3 2/4] Documentation/atomic_ops.txt: " Silvio Fricke
2016-11-25 21:01 ` Mauro Carvalho Chehab
2016-11-25 21:58 ` Peter Zijlstra
2016-11-27 14:53 ` S. Fricke
2016-11-27 18:36 ` Jani Nikula
2016-11-27 23:59 ` Jonathan Corbet
2016-11-28 7:26 ` Peter Zijlstra
2016-11-28 8:44 ` Daniel Vetter
2016-11-28 10:20 ` Peter Zijlstra
2016-11-28 11:08 ` Mauro Carvalho Chehab
2016-11-28 11:54 ` Peter Zijlstra
2016-11-28 13:46 ` Daniel Vetter
2016-11-28 15:14 ` Mauro Carvalho Chehab [this message]
2016-11-28 11:16 ` Jani Nikula
2016-11-28 11:56 ` Peter Zijlstra
2016-11-28 12:32 ` Jani Nikula
2016-11-28 14:13 ` Daniel Vetter
2016-11-28 14:29 ` Jonathan Corbet
2016-11-25 14:59 ` [PATCH v3 3/4] Documentation/local_ops.txt: " Silvio Fricke
2016-11-25 21:10 ` Mauro Carvalho Chehab
2016-11-25 14:59 ` [PATCH v3 4/4] firmware: remove warning at documentation generation time Silvio Fricke
2016-11-25 20:50 ` Mauro Carvalho Chehab
2016-12-01 16:11 ` Luis R. Rodriguez
2016-12-01 16:45 ` Greg Kroah-Hartman
2016-11-28 17:30 ` [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke
2016-11-28 17:30 ` [PATCH v4 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke
2016-11-28 17:30 ` [PATCH v4 2/4] Documentation/local_ops.txt: " Silvio Fricke
2016-11-28 17:30 ` [PATCH v4 3/4] Documentation/atomic_ops.txt: " Silvio Fricke
2016-11-28 17:30 ` [PATCH v4 4/4] firmware: remove warning at documentation generation time Silvio Fricke
2016-12-01 0:51 ` [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Jonathan Corbet
2016-12-01 15:49 ` Luis R. Rodriguez
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20161128131446.5e00d478@vento.lan \
--to=mchehab@s-opensource.com \
--cc=corbet@lwn.net \
--cc=daniel@ffwll.ch \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mcgrof@kernel.org \
--cc=mchehab@kernel.org \
--cc=ming.lei@canonical.com \
--cc=peterz@infradead.org \
--cc=silvio.fricke@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).