From: Bagas Sanjaya <bagasdotme@gmail.com>
To: linux-doc@vger.kernel.org
Cc: Bagas Sanjaya <bagasdotme@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
"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: [PATCH v4 1/2] Documentation: kernel-doc: Promote two chapter headings to page title
Date: Tue, 29 Mar 2022 11:52:34 +0700 [thread overview]
Message-ID: <20220329045235.11879-2-bagasdotme@gmail.com> (raw)
In-Reply-To: <20220329045235.11879-1-bagasdotme@gmail.com>
Promote "Writing kernel-doc comments" heading to page title, in
accordance to kernel documentation guidelines. Also promote "Including
kernel-doc comments" heading because both headings deserve their own
chapters in PDF output.
There is no differences in the resulting output except formatting
semantics.
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: "David S. Miller" <davem@davemloft.net>
Cc: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Cc: Tony Nguyen <anthony.l.nguyen@intel.com>
Cc: Vinod Koul <vkoul@kernel.org>
Cc: Daniel Borkmann <daniel@iogearbox.net>
Cc: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Cc: Akira Yokosawa <akiyks@gmail.com>
Cc: "Rafael J. Wysocki" <rafael.j.wysocki@intel.com>
Cc: Jens Axboe <axboe@kernel.dk>
Cc: linux-kernel@vger.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/doc-guide/kernel-doc.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index 79aaa55d6bcf2b..a7cb2afd799007 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -1,3 +1,4 @@
+===========================
Writing kernel-doc comments
===========================
@@ -436,6 +437,7 @@ The title following ``DOC:`` acts as a heading within the source file, but also
as an identifier for extracting the documentation comment. Thus, the title must
be unique within the file.
+=============================
Including kernel-doc comments
=============================
--
An old man doll... just what I always wanted! - Clara
next prev parent reply other threads:[~2022-03-29 4:52 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 ` Bagas Sanjaya [this message]
2022-03-29 4:52 ` [PATCH v4 2/2] Documentation: sphinx: replace "Introduction" chapter heading with page title Bagas Sanjaya
2022-04-05 16:04 ` [PATCH v4 0/2] Documentation: doc-guide: Add missing page titles 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=20220329045235.11879-2-bagasdotme@gmail.com \
--to=bagasdotme@gmail.com \
--cc=akiyks@gmail.com \
--cc=anthony.l.nguyen@intel.com \
--cc=axboe@kernel.dk \
--cc=corbet@lwn.net \
--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.