Re: [PATCH 1/2] Documentation/core-api/device_link: Add initial documentation

From: Mauro Carvalho Chehab
Date: Mon Dec 05 2016 - 08:37:39 EST


Em Mon, 5 Dec 2016 06:05:07 -0700
Jonathan Corbet <corbet@xxxxxxx> escreveu:

> On Mon, 5 Dec 2016 10:07:39 -0200
> Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxx> wrote:
>
> > > +Usage
> > > +=====
> >
> > You should be using, instead:
> >
> > Usage
> > -----
> >
> > (and the same '-' symbol for all sections of this chapter)
> >
> > The way you did, in thesis, ReST should be putting all tags at the
> > same level as the first one, as they're all using '='.
>
> Actually, he did exactly what the documentation guide says to do.

Ah, OK! I guess I misread that section of the documentation.

> Since
> it only has the markers below the heading, it will still be at a lower
> level than the top heading, which has markers both above and below.

Yes, I noticed that it is on a lower level than the initial one with
markers above and below.


Lukas,

Documentation seems OK, from ReST PoV. Didn't read the documents
and the C code to be sure that they match the implementation.

Reviewed-by: Mauro Carvalho Chehab <mchehab@xxxxxxxxxxxxxxxx>


--
Thanks,
Mauro