linux-kernel - [PATCH] Documentation: kernel-doc: Use descriptive mood for chapter headings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20220326125036.667960-1-bagasdotme@gmail.com>
Date:   Sat, 26 Mar 2022 19:50:37 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     linux-doc@...r.kernel.org
Cc:     Bagas Sanjaya <bagasdotme@...il.com>,
        Jonathan Corbet <corbet@....net>,
        "David S. Miller" <davem@...emloft.net>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        Jens Axboe <axboe@...nel.dk>,
        Mauro Carvalho Chehab <mchehab+huawei@...nel.org>,
        Akira Yokosawa <akiyks@...il.com>, linux-kernel@...r.kernel.org
Subject: [PATCH] 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 <corbet@....net>
Cc: "David S. Miller" <davem@...emloft.net>
Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org>
Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>
Cc: Jens Axboe <axboe@...nel.dk>
Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org>
Cc: Akira Yokosawa <akiyks@...il.com>
Cc: linux-kernel@...r.kernel.org
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.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