public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Johannes Berg <johannes@sipsolutions.net>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
	David Woodhouse <dwmw2@infradead.org>,
	Brian Norris <computersforpeace@gmail.com>,
	Boris Brezillon <boris.brezillon@free-electrons.com>,
	Marek Vasut <marek.vasut@gmail.com>,
	Richard Weinberger <richard@nod.at>,
	Cyrille Pitchen <cyrille.pitchen@atmel.com>,
	linux-mtd@lists.infradead.org, linux-wireless@vger.kernel.org
Subject: Re: [PATCH 08/29] rfkill.txt: standardize document format
Date: Fri, 19 May 2017 08:11:17 -0300	[thread overview]
Message-ID: <20170519081117.6da0a699@vento.lan> (raw)
In-Reply-To: <1495188901.3274.0.camel@sipsolutions.net>

Em Fri, 19 May 2017 12:15:01 +0200
Johannes Berg <johannes@sipsolutions.net> escreveu:

> On Thu, 2017-05-18 at 22:25 -0300, Mauro Carvalho Chehab wrote:
> > 
> > +.. CONTENTS
> >  
> > +  1. Introduction
> > +  2. Implementation details
> > +  3. Kernel API
> > +  4. Userspace support  
> 
> Why not let this be auto-generated?
> 
> .. contents::
>    :depth: 1
> 
> should work, no?

Yes, it should work. Actually, you would need to use :depth: 2 to
produce this output:


	Contents

	    . rfkill - RF kill switch support
	        . Introduction
	        . Implementation details
	        . Kernel API
	        . Userspace support

I opted to keep the contents as a comment just because, in the past, some
maintainers complained about TOC removal, arguing that it makes harder
for the ones that would be reading the file in ascii.

Thanks,
Mauro

  reply	other threads:[~2017-05-19 11:11 UTC|newest]

Thread overview: 45+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-05-19  1:25 [PATCH 00/29] Standardize doc formats - part 3 Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 01/29] pinctrl.txt: standardize document format Mauro Carvalho Chehab
2017-05-23  9:12   ` Linus Walleij
2017-06-17 15:03     ` Mauro Carvalho Chehab
2017-06-20 11:12       ` Linus Walleij
2017-05-19  1:25 ` [PATCH 02/29] pnp.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 03/29] preempt-locking.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 04/29] printk-formats.txt: " Mauro Carvalho Chehab
2017-05-19 10:26   ` Joe Perches
2017-05-19 20:28     ` Mauro Carvalho Chehab
2017-05-19 23:37       ` Randy Dunlap
2017-06-17 14:55         ` Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 05/29] pwm.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 06/29] rbtree.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 07/29] remoteproc.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 08/29] rfkill.txt: " Mauro Carvalho Chehab
2017-05-19 10:15   ` Johannes Berg
2017-05-19 11:11     ` Mauro Carvalho Chehab [this message]
2017-05-19 11:16       ` Johannes Berg
2017-05-19  1:25 ` [PATCH 09/29] robust-futex-ABI.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 10/29] robust-futexes.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 11/29] rpmsg.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 12/29] rtc.txt: " Mauro Carvalho Chehab
2017-05-31 11:17   ` Alexandre Belloni
2017-05-19  1:25 ` [PATCH 13/29] SAK.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 14/29] sgi-ioc4.txt: " Mauro Carvalho Chehab
2017-05-19  1:25 ` [PATCH 15/29] siphash.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 16/29] SM501.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 17/29] smsc_ece1099.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 18/29] static-keys.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 19/29] svga.txt: " Mauro Carvalho Chehab
2017-05-19 13:50   ` Martin Mares
2017-05-19  1:26 ` [PATCH 20/29] sync_file.txt: " Mauro Carvalho Chehab
2017-05-25  1:36   ` Gustavo Padovan
2017-05-25  5:16     ` Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 21/29] this_cpu_ops.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 22/29] unaligned-memory-access.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 23/29] vfio-mediated-device.txt: " Mauro Carvalho Chehab
2017-05-22 19:38   ` Kirti Wankhede
2017-05-19  1:26 ` [PATCH 24/29] vfio.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 25/29] video-output.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 26/29] xillybus.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 27/29] xz.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 28/29] zorro.txt: " Mauro Carvalho Chehab
2017-05-19  1:26 ` [PATCH 29/29] dell_rbu.txt: " Mauro Carvalho Chehab

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=20170519081117.6da0a699@vento.lan \
    --to=mchehab@s-opensource.com \
    --cc=boris.brezillon@free-electrons.com \
    --cc=computersforpeace@gmail.com \
    --cc=corbet@lwn.net \
    --cc=cyrille.pitchen@atmel.com \
    --cc=dwmw2@infradead.org \
    --cc=johannes@sipsolutions.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-mtd@lists.infradead.org \
    --cc=linux-wireless@vger.kernel.org \
    --cc=marek.vasut@gmail.com \
    --cc=mchehab@infradead.org \
    --cc=richard@nod.at \
    /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