From: Jonathan Corbet <corbet@lwn.net>
To: Bagas Sanjaya <bagasdotme@gmail.com>, linux-doc@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
Tony Nguyen <anthony.l.nguyen@intel.com>,
Vinod Koul <vkoul@kernel.org>,
Daniel Borkmann <daniel@iogearbox.net>,
Mauro Carvalho Chehab <mchehab+huawei@kernel.org>,
Akira Yokosawa <akiyks@gmail.com>,
"Rafael J. Wysocki" <rafael.j.wysocki@intel.com>,
Jens Axboe <axboe@kernel.dk>,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v4 0/2] Documentation: doc-guide: Add missing page titles
Date: Tue, 05 Apr 2022 10:04:30 -0600 [thread overview]
Message-ID: <87sfqrectt.fsf@meer.lwn.net> (raw)
In-Reply-To: <20220329045235.11879-1-bagasdotme@gmail.com>
Bagas Sanjaya <bagasdotme@gmail.com> writes:
> The kernel documentation guidelines [1] lists that there should have page
> title.
>
> Add missing page title for kernel-doc.rst and sphinx.rst, in accordance
> to the guideline.
>
> Changes since v3 [2]:
> - Clarify that there is no output differences except formatting
> semantics in [1/2]
> - Drop Suggested-by trailer from Akira Yokosawa in [1/2]
>
> [1]: https://docs.kernel.org/doc-guide/sphinx.html#specific-guidelines-for-the-kernel-documentation
> [2]:
> https://lore.kernel.org/linux-doc/20220328065030.24936-1-bagasdotme@gmail.com/
>
> Bagas Sanjaya (2):
> Documentation: kernel-doc: Promote two chapter headings to page title
> Documentation: sphinx: replace "Introduction" chapter heading with
> page title
>
> Documentation/doc-guide/kernel-doc.rst | 2 ++
> Documentation/doc-guide/sphinx.rst | 5 +++--
> 2 files changed, 5 insertions(+), 2 deletions(-)
OK, I think this improves the situation overall, so I've applied these,
thanks.
jon
prev parent reply other threads:[~2022-04-05 22:39 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-03-29 4:52 [PATCH v4 0/2] Documentation: doc-guide: Add missing page titles Bagas Sanjaya
2022-03-29 4:52 ` [PATCH v4 1/2] Documentation: kernel-doc: Promote two chapter headings to page title Bagas Sanjaya
2022-03-29 4:52 ` [PATCH v4 2/2] Documentation: sphinx: replace "Introduction" chapter heading with " Bagas Sanjaya
2022-04-05 16:04 ` Jonathan Corbet [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=87sfqrectt.fsf@meer.lwn.net \
--to=corbet@lwn.net \
--cc=akiyks@gmail.com \
--cc=anthony.l.nguyen@intel.com \
--cc=axboe@kernel.dk \
--cc=bagasdotme@gmail.com \
--cc=daniel@iogearbox.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 \
--cc=vkoul@kernel.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.