* [PATCH] Documentation: kernel-doc: Use descriptive mood for chapter headings
@ 2022-03-26 12:50 Bagas Sanjaya
0 siblings, 0 replies; only message in thread
From: Bagas Sanjaya @ 2022-03-26 12:50 UTC (permalink / raw)
To: linux-doc
Cc: Bagas Sanjaya, Jonathan Corbet, David S. Miller,
Greg Kroah-Hartman, Rafael J. Wysocki, Jens Axboe,
Mauro Carvalho Chehab, Akira Yokosawa, linux-kernel
Use descriptive mood (with present continous) instead of interrogative
mood (without question mark) for writing chapter headings.
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>
---
This patch is applied on top of "Add missing page title" series [1].
[1]: https://lore.kernel.org/linux-doc/20220326123337.642536-1-bagasdotme@gmail.com/
Documentation/doc-guide/kernel-doc.rst | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/Documentation/doc-guide/kernel-doc.rst b/Documentation/doc-guide/kernel-doc.rst
index ea41e05d0e8903..fbcd9f553a8382 100644
--- a/Documentation/doc-guide/kernel-doc.rst
+++ b/Documentation/doc-guide/kernel-doc.rst
@@ -31,8 +31,8 @@ documentation for private (file ``static``) routines, for consistency of
kernel source code layout. This is lower priority and at the discretion
of the maintainer of that kernel source file.
-How to format kernel-doc comments
-=================================
+Formatting kernel-doc comments
+==============================
The opening comment mark ``/**`` is used for kernel-doc comments. The
``kernel-doc`` tool will extract comments marked this way. The rest of
@@ -524,8 +524,8 @@ source.
.. _kernel_doc:
-How to use kernel-doc to generate man pages
-===========================================
+Using kernel-doc to generate man pages
+======================================
If you just want to use kernel-doc to generate man pages you can do this
from the kernel git tree::
base-commit: c4118934eeb6b26b20d52cd0a1f326440ac8f763
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] only message in thread
only message in thread, other threads:[~2022-03-26 12:51 UTC | newest]
Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-03-26 12:50 [PATCH] Documentation: kernel-doc: Use descriptive mood for chapter headings Bagas Sanjaya
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®