Re: [PATCH 08/29] rfkill.txt: standardize document format

From	Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups	linux.kernel
Subject	Re: [PATCH 08/29] rfkill.txt: standardize document format
Date	2017-05-19 13:20 +0200
Message-ID	<tIO6R-1nG-11@gated-at.bofh.it> (permalink)
References	<tIETU-39a-9@gated-at.bofh.it> <tIETV-39a-63@gated-at.bofh.it> <tINaN-JU-5@gated-at.bofh.it>
Organization	Samsung

Show all headers | View raw

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

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

Thread

[PATCH 08/29] rfkill.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-19 03:30 +0200
  Re: [PATCH 08/29] rfkill.txt: standardize document format Johannes Berg <johannes@sipsolutions.net> - 2017-05-19 12:20 +0200
    Re: [PATCH 08/29] rfkill.txt: standardize document format Johannes Berg <johannes@sipsolutions.net> - 2017-05-19 13:20 +0200
    Re: [PATCH 08/29] rfkill.txt: standardize document format Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-19 13:20 +0200

csiph-web