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

[Mauro Carvalho Chehab]

Em Tue, 29 Nov 2016 11:28:12 +0100
Markus Heiser <markus.heiser@xxxxxxxxxxx> escreveu:

> Am 29.11.2016 um 10:23 schrieb Daniel Vetter <daniel.vetter@xxxxxxxx>:
> 
> > 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@xxxxxxx>
> > Cc: linux-doc@xxxxxxxxxxxxxxx
> > Cc: Christoph Hellwig <hch@xxxxxxxxxxxxx>
> > Cc: Peter Zijlstra <peterz@xxxxxxxxxxxxx>
> > Cc: Jani Nikula <jani.nikula@xxxxxxxxxxxxxxx>
> > Cc: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> > Signed-off-by: Daniel Vetter <daniel.vetter@xxxxxxxxx>
> > ---
> > 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.

I agree that we should define the preferred spaces style.

Yet, I very much prefer that patches converting existing documents
to not touch whitespaces/tabs except when really needed.

>From my side, the editors I use to write documents are set to automatically 
convert 8 column alignments to tabs. I also have a script that I run when
needed, when I receive a patch with whitespaces at the end of lines.
It also converts spaces to tabs where needed.

So, whatever definition we use, IMO we should define that a tab has
8 spaces, and that tabs should be used if the alignment requires
more than 8 columns.

With regards of using indentation with 2 spaces, I don't have any
strong opinion.

>From what I remember, the scripts you used to convert the media
documents made a 4 spaces alignment for the media documentation
on several places, but I may be wrong.

Thanks,
Mauro