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
| ||
|
Date: Tue, 29 Mar 2022 11:52:34 +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>, Tony Nguyen <anthony.l.nguyen@...el.com>, Vinod Koul <vkoul@...nel.org>, Daniel Borkmann <daniel@...earbox.net>, Mauro Carvalho Chehab <mchehab+huawei@...nel.org>, Akira Yokosawa <akiyks@...il.com>, "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>, Jens Axboe <axboe@...nel.dk>, linux-kernel@...r.kernel.org Subject: [PATCH v4 1/2] Documentation: kernel-doc: Promote two chapter headings to page title Promote "Writing kernel-doc comments" heading to page title, in accordance to kernel documentation guidelines. Also promote "Including kernel-doc comments" heading because both headings deserve their own chapters in PDF output. There is no differences in the resulting output except formatting semantics. Cc: Jonathan Corbet <corbet@....net> Cc: "David S. Miller" <davem@...emloft.net> Cc: Greg Kroah-Hartman <gregkh@...uxfoundation.org> Cc: Tony Nguyen <anthony.l.nguyen@...el.com> Cc: Vinod Koul <vkoul@...nel.org> Cc: Daniel Borkmann <daniel@...earbox.net> Cc: Mauro Carvalho Chehab <mchehab+huawei@...nel.org> Cc: Akira Yokosawa <akiyks@...il.com> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@...el.com> Cc: Jens Axboe <axboe@...nel.dk> Cc: linux-kernel@...r.kernel.org Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com> --- 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
Powered by blists - more mailing lists