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

Groups > linux.kernel > #1532104

Re: [PATCH] doc: Explain light-handed markup preference a bit better

Show all headers | View raw

Am 29.11.2016 um 10:23 schrieb Daniel Vetter <daniel.vetter@ffwll.ch>:

> We already had a super-short blurb, but worth extending it I think:
> We're still pretty far away from anything like a consensus, but
> there's clearly a lot of people who prefer an as-light as possible
> approach to converting existing .txt files to .rst. Make sure this is
> properly taken into account and clear.
> 
> Motivated by discussions with Peter and Christoph and others.
> 
> v2:
> - Mention that existing headings should be kept when converting
> existing .txt files (Mauro).
> - Explain that we prefer :: for quoting code, it's easier on the
> eyes (Mauro).
> - Explain that blindly converting outdated docs is harmful. Motived
> by comments Peter did in our discussion.
> 
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: linux-doc@vger.kernel.org
> Cc: Christoph Hellwig <hch@infradead.org>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Jani Nikula <jani.nikula@linux.intel.com>
> Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com>
> ---
> Documentation/kernel-documentation.rst | 44 ++++++++++++++++++++++++++++++++--
> 1 file changed, 42 insertions(+), 2 deletions(-)

Sorry for my dump remarks ...

* shouldn't it on top of Jon's docs-next?
* should we lose a few words about tabs/indentation?

IMO indentation for reST markup should be 2 spaces, not
tabs (8 spaces). I know about CodeStyling but I think this doc
(markup) and not source-code. Code-examples should be indent
by tabs as usual. BTW here is what CodingStyle says:

 Outside of comments, documentation and except in Kconfig,
 spaces are never used for indentation, and the above example
 is deliberately broken.
 Get a decent editor and don't leave whitespace at the end of
 lines.

... encourages me to prefer spaces.

-- Markus --

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

Thread

[PATCH] doc: Explain light-handed markup preference a bit better Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-11-29 10:30 +0100
  Re: [PATCH] doc: Explain light-handed markup preference a bit better Markus Heiser <markus.heiser@darmarit.de> - 2016-11-29 11:30 +0100
    Re: [PATCH] doc: Explain light-handed markup preference a bit  better Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-29 13:00 +0100
  Re: [PATCH] doc: Explain light-handed markup preference a bit better Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-29 11:40 +0100
    Re: [PATCH] doc: Explain light-handed markup preference a bit  better Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2016-11-29 12:50 +0100
      Re: [PATCH] doc: Explain light-handed markup preference a bit better Jani Nikula <jani.nikula@linux.intel.com> - 2016-11-29 16:20 +0100
        Re: [PATCH] doc: Explain light-handed markup preference a bit better Daniel Vetter <daniel@ffwll.ch> - 2016-12-07 16:50 +0100
  Re: [PATCH] doc: Explain light-handed markup preference a bit better Daniel Vetter <daniel@ffwll.ch> - 2016-11-29 14:20 +0100
    Re: [PATCH] doc: Explain light-handed markup preference a bit better Peter Zijlstra <peterz@infradead.org> - 2016-12-06 09:00 +0100
      Re: [PATCH] doc: Explain light-handed markup preference a bit better Daniel Vetter <daniel@ffwll.ch> - 2016-12-07 16:50 +0100

csiph-web