From 00dee87810628b25df761da98de2682b47dcca7b Mon Sep 17 00:00:00 2001
From: Randy Dunlap <randy.dunlap@oracle.com>
Date: Tue, 6 Jan 2009 14:42:43 -0800
Subject: [PATCH] --- yaml --- r: 126399 b: refs/heads/master c:
 28f4d75a618e52f93d8e4a3e7bc66db8c882d679 h: refs/heads/master i:   126397:
 f4f3f606d26cfab742ada31dd4f4b298d3df7eb8   126395:
 c104bebd93eb7f8ec7582b3652fff63bebf8c05b   126391:
 e9a5b014d01506334d3522351bf993b6b7818d13   126383:
 a15cc32a8ca4ab940cc9680dd63f91e5c563e90a   126367:
 60dda7472b4cc5b02213626f6dccfdfcd8d9feb3   126335:
 7c9003f37870c8e3b51263a43f2a23757ffb91aa v: v3

---
 [refs]                                        |  2 +-
 trunk/Documentation/kernel-doc-nano-HOWTO.txt | 29 +++++++++++++++++++
 2 files changed, 30 insertions(+), 1 deletion(-)

diff --git a/[refs] b/[refs]
index befa50b4db1e..9b81b401cdb7 100644
--- a/[refs]
+++ b/[refs]
@@ -1,2 +1,2 @@
 ---
-refs/heads/master: 58cc855c395fc22db996cc893134c4c690f0f0dc
+refs/heads/master: 28f4d75a618e52f93d8e4a3e7bc66db8c882d679
diff --git a/trunk/Documentation/kernel-doc-nano-HOWTO.txt b/trunk/Documentation/kernel-doc-nano-HOWTO.txt
index 4115a4a80eb6..d73fbd2b2b45 100644
--- a/trunk/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/trunk/Documentation/kernel-doc-nano-HOWTO.txt
@@ -287,6 +287,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
 -----------------------------------
 
@@ -307,6 +333,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@redhat.com>