Use descriptive mood (with present continous) instead of interrogative mood (without question mark) for writing chapter headings. Cc: Jonathan Corbet <corbet@xxxxxxx> Cc: "David S. Miller" <davem@xxxxxxxxxxxxx> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@xxxxxxxxx> Cc: Jens Axboe <axboe@xxxxxxxxx> Cc: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx> Cc: Akira Yokosawa <akiyks@xxxxxxxxx> Cc: linux-kernel@xxxxxxxxxxxxxxx Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx> --- This patch is applied on top of "Add missing page title" series [1]. [1]: https://lore.kernel.org/linux-doc/20220326123337.642536-1-bagasdotme@xxxxxxxxx/ 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
