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

Mauro Carvalho Chehab
2017-05-19T11:11:29Z

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