Re: [PATCH 05/14] Documentation/kernel-docs.txt: Consistent indenting: 4 spaces

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Am 20.09.2016 um 13:36 schrieb Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>:

> From: Richard Sailer <richard@xxxxxxxxxxxxxxxxxx>
> 
> This introduces a consistent indenting of 4 spaces for all
> lists.
> 
> [mchehab@xxxxxxxxxxxxxxxx: rebased to apply before rename]
> 
> Signed-off-by: Richard Sailer <richard@xxxxxxxxxxxxxxxxxx>
> Signed-off-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>
> ---
> Documentation/kernel-docs.txt | 1222 ++++++++++++++++++++---------------------
> 1 file changed, 611 insertions(+), 611 deletions(-)
> 
> diff --git a/Documentation/kernel-docs.txt b/Documentation/kernel-docs.txt
> index c3a8462a4012..fc1474419c81 100644
> --- a/Documentation/kernel-docs.txt
> +++ b/Documentation/kernel-docs.txt
> @@ -37,640 +37,640 @@ Enjoy!
> ON-LINE DOCS
> ------------
> 
> -     * Title: **Linux Device Drivers, Third Edition**
> -
> -       :Author: Jonathan Corbet, Alessandro Rubini, Greg Kroah-Hartman
> -       :URL: http://lwn.net/Kernel/LDD3/
> -       :Description: A 600-page book covering the (2.6.10) driver
> -         programming API and kernel hacking in general.  Available under the
> -         Creative Commons Attribution-ShareAlike 2.0 license.


FYI: in reST-markup nearly most whitespace are markups ;)

What I mean, do not indent paragraph or lists if you don't want an indentation
in the output. The 4 spaces in front of the list item are indenting the complete
list, not only in ASCII also in the rendered formats. I recommend a more flat
notation with less indentation:


ON-LINE DOCS
------------

* Title: **Linux Device Drivers, Third Edition**

 :Author: Jonathan Corbet, Alessandro Rubini, Greg Kroah-Hartman
 :URL: http://lwn.net/Kernel/LDD3/
 :Description: A 600-page book covering the (2.6.10) driver programming API and
   kernel hacking in general.  Available under the Creative Commons
   Attribution-ShareAlike 2.0 license.

* Title: **The Linux Kernel**

 :Author: David A. Rusling.
 :URL: http://www.tldp.org/LDP/tlk/tlk.html

-- Markus --

* reST primer:    http://www.sphinx-doc.org/en/stable/rest.html
* reST quickref:  http://docutils.sourceforge.net/docs/user/rst/quickref.html
* Sphinx markup constructs: http://www.sphinx-doc.org/en/stable/markup/index.html
* Sphinx domains: http://www.sphinx-doc.org/en/stable/domains.html
* Sphinx cross references:  http://www.sphinx-doc.org/en/stable/markup/inline.html#cross-referencing-arbitrary-locations

https://www.mail-archive.com/linux-doc@xxxxxxxxxxxxxxx/msg05040.html


--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux