From: Mauro Carvalho Chehab <mchehab@kernel.org>
To: Bagas Sanjaya <bagasdotme@gmail.com>
Cc: linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
"David S. Miller" <davem@davemloft.net>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
"Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
Jens Axboe <axboe@kernel.dk>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 2/2] Documentation: sphinx: replace "Introduction" chapter heading with page title
Date: Sat, 26 Mar 2022 14:57:21 +0100 [thread overview]
Message-ID: <20220326145708.7926b29d@coco.lan> (raw)
In-Reply-To: <20220326123337.642536-3-bagasdotme@gmail.com>
Em Sat, 26 Mar 2022 19:33:38 +0700
Bagas Sanjaya <bagasdotme@gmail.com> escreveu:
> Replace first chapter heading ("Introduction") with page title named
> "Using Sphinx for kernel documentation". This way, the first-level TOC
> for doc-guide contains title instead of chapter headings for this page.
>
> Cc: Jonathan Corbet <corbet@lwn.net>
> Cc: "David S. Miller" <davem@davemloft.net>
> Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>
> Cc: Jens Axboe <axboe@kernel.dk>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> Cc: Akira Yokosawa <akiyks@gmail.com>
> Cc: linux-kernel@vger.kernel.org
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
> Documentation/doc-guide/sphinx.rst | 5 +++--
> 1 file changed, 3 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index bb36f18ae9ac3e..2ff1ab4158d48e 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -1,7 +1,8 @@
> .. _sphinxdoc:
>
> -Introduction
> -============
> +=====================================
> +Using Sphinx for kernel documentation
> +=====================================
>
> The Linux kernel uses `Sphinx`_ to generate pretty documentation from
> `reStructuredText`_ files under ``Documentation``. To build the documentation in
Thanks,
Mauro
prev parent reply other threads:[~2022-03-26 13:57 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-26 12:33 [PATCH v2 0/2] Documentation: doc-guide: Add missing page titles Bagas Sanjaya
2022-03-26 12:33 ` [PATCH v2 1/2] Documentation: kernel-doc: Promote "Writing kernel-doc comments" to page title Bagas Sanjaya
2022-03-26 13:56 ` Mauro Carvalho Chehab
2022-03-27 5:27 ` Bagas Sanjaya
2022-03-27 8:50 ` Akira Yokosawa
2022-03-26 12:33 ` [PATCH v2 2/2] Documentation: sphinx: replace "Introduction" chapter heading with " Bagas Sanjaya
2022-03-26 13:57 ` Mauro Carvalho Chehab [this message]
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=20220326145708.7926b29d@coco.lan \
--to=mchehab@kernel.org \
--cc=akiyks@gmail.com \
--cc=axboe@kernel.dk \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=gregkh@linuxfoundation.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab+huawei@kernel.org \
--cc=rafael.j.wysocki@intel.com \
/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;
as well as URLs for NNTP newsgroup(s).