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

Groups > linux.kernel > #1531243

Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup

Show all headers | View raw

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_


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

> - if you use special characters like '*' in the middle of the text
>   (outsize a literal block), prepend with a \ in order to escape
>   parsing it.

That's a bit inconvenient I suppose.

> Btw, a lot of editors recognize ReST files and are capable of
> parsing the ReST tags while displaying the file, including vim
> and emacs, using different colors and/or bold to display those tags.
> So, even for text-editing, converting to ReST brings improvements.

Doesn't seem to really work though; if I open
Documentation/development-process/1.Intro.rst the :ref:s at the start of
the document don't work with the regular 'follow-ref' key combo of ^].

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

Thread

[PATCH v2 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 11:10 +0100
  [PATCH v3 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
    [PATCH v3 4/4] firmware: remove warning at documentation generation time Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
      Re: [PATCH v3 4/4] firmware: remove warning at documentation  generation time Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-25 22:00 +0100
        Re: [PATCH v3 4/4] firmware: remove warning at documentation  generation time "Luis R. Rodriguez" <mcgrof@kernel.org> - 2016-12-01 17:20 +0100
          Re: [PATCH v3 4/4] firmware: remove warning at documentation  generation time Greg Kroah-Hartman <gregkh@linuxfoundation.org> - 2016-12-01 17:50 +0100
    [PATCH v3 3/4] Documentation/local_ops.txt: convert to ReST markup Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
      Re: [PATCH v3 3/4] Documentation/local_ops.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-25 22:20 +0100
    [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-25 16:10 +0100
      Re: [PATCH v3 1/4] Documentation/assoc_array.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-25 22:00 +0100
    Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-25 23:00 +0100
      Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup "S. Fricke" <silvio.fricke@gmail.com> - 2016-11-27 16:00 +0100
        Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-27 19:40 +0100
      Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Jonathan Corbet <corbet@lwn.net> - 2016-11-28 01:00 +0100
        Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 08:30 +0100
          Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Daniel Vetter <daniel@ffwll.ch> - 2016-11-28 09:50 +0100
            Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 11:30 +0100
              Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-28 12:10 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 13:00 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Daniel Vetter <daniel@ffwll.ch> - 2016-11-28 14:50 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-28 16:20 +0100
              Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-28 12:20 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Peter Zijlstra <peterz@infradead.org> - 2016-11-28 13:00 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST markup Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-28 13:40 +0100
              Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Daniel Vetter <daniel@ffwll.ch> - 2016-11-28 15:20 +0100
                Re: [PATCH v3 2/4] Documentation/atomic_ops.txt: convert to ReST  markup Jonathan Corbet <corbet@lwn.net> - 2016-11-28 15:30 +0100
    [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops, local_ops Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-28 18:40 +0100
      [PATCH v4 1/4] Documentation/assoc_array.txt: convert to ReST markup Silvio Fricke <silvio.fricke@gmail.com> - 2016-11-28 18:40 +0100
      Re: [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops,  local_ops Jonathan Corbet <corbet@lwn.net> - 2016-12-01 02:00 +0100
        Re: [PATCH v4 0/4] core-api ReST: assoc_array, atomic_ops, local_ops "Luis R. Rodriguez" <mcgrof@kernel.org> - 2016-12-01 17:00 +0100

csiph-web