linux-kernel - [PATCH] documentation: how to use DOC: section blocks

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 for Android: free password hash cracker in your pocket

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

Message-Id: <20081218105709.a9733304.randy.dunlap@oracle.com>
Date:	Thu, 18 Dec 2008 10:57:09 -0800
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	lkml <linux-kernel@...r.kernel.org>
Cc:	linux-doc@...r.kernel.org, akpm <akpm@...ux-foundation.org>,
	Johannes Berg <johannes@...solutions.net>
Subject: [PATCH] documentation: how to use DOC: section blocks

From: Randy Dunlap <randy.dunlap@...cle.com>

Add info on how to use DOC: sections in kernel-doc.
DOC: sections enable the addition of inline source file comments
that are general in nature instead of being specific to a
function, struct, union, enum, or typedef.

Signed-off-by: Randy Dunlap <randy.dunlap@...cle.com>
cc: Johannes Berg <johannes@...solutions.net>
---
 Documentation/kernel-doc-nano-HOWTO.txt |   29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

--- linux-next-20081218.orig/Documentation/kernel-doc-nano-HOWTO.txt
+++ linux-next-20081218/Documentation/kernel-doc-nano-HOWTO.txt
@@ -282,6 +282,32 @@ struct my_struct {
 };
 
 
+Including documentation blocks in source files
+----------------------------------------------
+
+To facilitate having source code and comments close together, you can
+include kernel-doc documentation blocks that are free-form comments
+instead of being kernel-doc for functions, structures, unions,
+enums, or typedefs.  This could be used for something like a
+theory of operation for a driver or library code, for example.
+
+This is done by using a DOC: section keyword with a section title.  E.g.:
+
+/**
+ * DOC: Theory of Operation
+ *
+ * The whizbang foobar is a dilly of a gizmo.  It can do whatever you
+ * want it to do, at any time.  It reads your mind.  Here's how it works.
+ *
+ * foo bar splat
+ *
+ * The only drawback to this gizmo is that is can sometimes damage
+ * hardware, software, or its subject(s).
+ */
+
+DOC: sections are used in SGML templates files as indicated below.
+
+
 How to make new SGML template files
 -----------------------------------
 
@@ -302,6 +328,9 @@ exported using EXPORT_SYMBOL.
 !F<filename> <function [functions...]> is replaced by the
 documentation, in <filename>, for the functions listed.
 
+!P<filename> <section title> is replaced by the contents of the DOC:
+section titled <section title> from <filename>.
+Spaces are allowed in <section title>; do not quote the <section title>.
 
 Tim.
 */ <twaugh@...hat.com>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/