From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Cc: Lukas Wunner <lukas@wunner.de>,
"Rafael J. Wysocki" <rafael@kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Silvio Fricke <silvio.fricke@gmail.com>,
"Luis R. Rodriguez" <mcgrof@kernel.org>,
Marek Szyprowski <m.szyprowski@samsung.com>,
Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
Andrzej Hajda <a.hajda@samsung.com>,
Inki Dae <inki.dae@samsung.com>, Joerg Roedel <joro@8bytes.org>,
Kukjin Kim <kgene@kernel.org>,
Krzysztof Kozlowski <krzk@kernel.org>,
Mark Brown <broonie@kernel.org>,
Tomeu Vizoso <tomeu.vizoso@collabora.com>,
Kevin Hilman <khilman@kernel.org>,
Ulf Hansson <ulf.hansson@linaro.org>,
Geert Uytterhoeven <geert@linux-m68k.org>,
Tobias Jakobi <tjakobi@math.uni-bielefeld.de>,
Tomasz Figa <tomasz.figa@gmail.com>G
Subject: Re: [PATCH 1/2] Documentation/core-api/device_link: Add initial documentation
Date: Mon, 5 Dec 2016 06:05:07 -0700 [thread overview]
Message-ID: <20161205060507.6bd6e944@lwn.net> (raw)
In-Reply-To: <20161205100720.5156a4d2@vento.lan>
On Mon, 5 Dec 2016 10:07:39 -0200
Mauro Carvalho Chehab <mchehab@osg.samsung.com> 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. 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.
jon
WARNING: multiple messages have this Message-ID (diff)
From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@osg.samsung.com>
Cc: Lukas Wunner <lukas@wunner.de>,
"Rafael J. Wysocki" <rafael@kernel.org>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Silvio Fricke <silvio.fricke@gmail.com>,
"Luis R. Rodriguez" <mcgrof@kernel.org>,
Marek Szyprowski <m.szyprowski@samsung.com>,
Bartlomiej Zolnierkiewicz <b.zolnierkie@samsung.com>,
Andrzej Hajda <a.hajda@samsung.com>,
Inki Dae <inki.dae@samsung.com>, Joerg Roedel <joro@8bytes.org>,
Kukjin Kim <kgene@kernel.org>,
Krzysztof Kozlowski <krzk@kernel.org>,
Mark Brown <broonie@kernel.org>,
Tomeu Vizoso <tomeu.vizoso@collabora.com>,
Kevin Hilman <khilman@kernel.org>,
Ulf Hansson <ulf.hansson@linaro.org>,
Geert Uytterhoeven <geert@linux-m68k.org>,
Tobias Jakobi <tjakobi@math.uni-bielefeld.de>,
Tomasz Figa <tomasz.figa@gmail.com>,
Grant Likely <grant.likely@secretlab.ca>,
Laurent Pinchart <laurent.pinchart@ideasonboard.com>,
Lars-Peter Clausen <lars@metafoo.de>,
Dmitry Torokhov <dmitry.torokhov@gmail.com>,
Christoph Hellwig <hch@infradead.org>,
Arnd Bergmann <arnd@arndb.de>,
Alan Stern <stern@rowland.harvard.edu>,
Hanjun Guo <guohanjun@huawei.com>,
linux-pm@vger.kernel.org, linux-kernel@vger.kernel.org,
iommu@lists.linux-foundation.org,
linux-samsung-soc@vger.kernel.org
Subject: Re: [PATCH 1/2] Documentation/core-api/device_link: Add initial documentation
Date: Mon, 5 Dec 2016 06:05:07 -0700 [thread overview]
Message-ID: <20161205060507.6bd6e944@lwn.net> (raw)
In-Reply-To: <20161205100720.5156a4d2@vento.lan>
On Mon, 5 Dec 2016 10:07:39 -0200
Mauro Carvalho Chehab <mchehab@osg.samsung.com> 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. 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.
jon
next prev parent reply other threads:[~2016-12-05 13:05 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-04 12:10 [PATCH 0/2] Device links documentation Lukas Wunner
[not found] ` <cover.1480849144.git.lukas-JFq808J9C/izQB+pC5nmwQ@public.gmane.org>
2016-12-04 12:10 ` [PATCH 2/2] driver core: Silence device links sphinx warning Lukas Wunner
2016-12-05 12:20 ` Mauro Carvalho Chehab
2016-12-05 12:20 ` Mauro Carvalho Chehab
[not found] ` <20161205102030.2abae2b5-ch4gOOMV7nf/PtFMR13I2A@public.gmane.org>
2016-12-05 12:44 ` Lukas Wunner
2016-12-05 12:44 ` Lukas Wunner
[not found] ` <20161205124449.GA7539-JFq808J9C/izQB+pC5nmwQ@public.gmane.org>
2016-12-05 12:57 ` Mauro Carvalho Chehab
2016-12-05 12:57 ` Mauro Carvalho Chehab
[not found] ` <a1c7a93ee8ef057fb70aa3abeed38daf989444fc.1480849144.git.lukas-JFq808J9C/izQB+pC5nmwQ@public.gmane.org>
2016-12-05 13:59 ` Greg Kroah-Hartman
2016-12-05 13:59 ` Greg Kroah-Hartman
2016-12-05 22:21 ` Rafael J. Wysocki
2016-12-04 12:10 ` [PATCH 1/2] Documentation/core-api/device_link: Add initial documentation Lukas Wunner
2016-12-05 12:07 ` Mauro Carvalho Chehab
2016-12-05 12:07 ` Mauro Carvalho Chehab
2016-12-05 13:05 ` Jonathan Corbet [this message]
2016-12-05 13:05 ` Jonathan Corbet
[not found] ` <20161205060507.6bd6e944-T1hC0tSOHrs@public.gmane.org>
2016-12-05 13:36 ` Mauro Carvalho Chehab
2016-12-05 13:36 ` Mauro Carvalho Chehab
2016-12-05 21:15 ` Jonathan Corbet
[not found] ` <f5b568e349aaeb31039a0c4d01fdb05d8b3bdd2a.1480849144.git.lukas-JFq808J9C/izQB+pC5nmwQ@public.gmane.org>
2016-12-06 1:41 ` Luis R. Rodriguez
2016-12-06 1:41 ` Luis R. Rodriguez
2016-12-07 11:50 ` Lukas Wunner
2016-12-05 12:03 ` [PATCH 0/2] Device links documentation Mauro Carvalho Chehab
2016-12-05 12:03 ` Mauro Carvalho Chehab
2016-12-05 14:08 ` Christoph Hellwig
2016-12-05 14:19 ` Mauro Carvalho Chehab
2016-12-05 15:02 ` Lukas Wunner
2016-12-05 13:09 ` Jonathan Corbet
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=20161205060507.6bd6e944@lwn.net \
--to=corbet@lwn.net \
--cc=a.hajda@samsung.com \
--cc=b.zolnierkie@samsung.com \
--cc=broonie@kernel.org \
--cc=geert@linux-m68k.org \
--cc=gregkh@linuxfoundation.org \
--cc=inki.dae@samsung.com \
--cc=joro@8bytes.org \
--cc=kgene@kernel.org \
--cc=khilman@kernel.org \
--cc=krzk@kernel.org \
--cc=lukas@wunner.de \
--cc=m.szyprowski@samsung.com \
--cc=mcgrof@kernel.org \
--cc=mchehab@osg.samsung.com \
--cc=rafael@kernel.org \
--cc=silvio.fricke@gmail.com \
--cc=tjakobi@math.uni-bielefeld.de \
--cc=tomasz.figa@gmail.com \
--cc=tomeu.vizoso@collabora.com \
--cc=ulf.hansson@linaro.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.