Documentation: kernel-doc: Use descriptive mood for chapter headings
PATCH 1/1 Documentation: kernel-doc: Use descriptive mood for chapter headings
Use descriptive mood (with present continous) instead of interrogative mood (without question mark) for writing chapter headings.
Cc Jonathan Corbet <[email protected]>
Cc "David S. Miller" <[email protected]>
Cc Greg Kroah-Hartman <[email protected]>
Cc "Rafael J. Wysocki" <[email protected]>
Cc Jens Axboe <[email protected]>
Cc Mauro Carvalho Chehab <[email protected]>
Cc Akira Yokosawa <[email protected]>
Signed-off-by Bagas Sanjaya <[email protected]>
---
This patch is applied on top of "Add missing page title" series [1].
[1]: https://lore.kernel.org/linux-doc/[email protected]/
Documentation/doc-guide/kernel-doc.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/doc-guide/kernel-doc.rst +4 -4
@@ -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
Signature · 1 line
An old man doll... just what I always wanted! - Clara