[PATCH v3 1/2] Documentation: kernel-doc: Promote two chapter headings to page title

From: Bagas Sanjaya
Date: Mon Mar 28 2022 - 02:51:07 EST


Promote two chapter headings, named "Writing kernel-doc comments" and
"Including kernel-doc comments" to page title. These titles deserve
their own chapters in PDF output, although these will also appear as two
separate titles in table of contents in HTML output.

Cc: Jonathan Corbet <corbet@xxxxxxx>
Cc: "David S. Miller" <davem@xxxxxxxxxxxxx>
Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
Cc: Tony Nguyen <anthony.l.nguyen@xxxxxxxxx>
Cc: Vinod Koul <vkoul@xxxxxxxxxx>
Cc: Daniel Borkmann <daniel@xxxxxxxxxxxxx>
Cc: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
Cc: Akira Yokosawa <akiyks@xxxxxxxxx>
Cc: "Rafael J. Wysocki" <rafael.j.wysocki@xxxxxxxxx>
Cc: Jens Axboe <axboe@xxxxxxxxx>
Cc: linux-kernel@xxxxxxxxxxxxxxx
Suggested-by: Akira Yokosawa <akiyks@xxxxxxxxx>
Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
---
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