patch-2.4.0-test2 linux/Documentation/kernel-doc-nano-HOWTO.txt

• Lines: 35
• Date: Mon Jun 19 12:56:07 2000
• Orig file: v2.4.0-test1/linux/Documentation/kernel-doc-nano-HOWTO.txt
• Orig date: Tue May 23 15:31:32 2000

diff -u --recursive --new-file v2.4.0-test1/linux/Documentation/kernel-doc-nano-HOWTO.txt linux/Documentation/kernel-doc-nano-HOWTO.txt
@@ -57,7 +57,7 @@
 If you want to see man pages instead, you can do this:
 
 $ cd linux
-$ scripts/kernel-doc -man $(find -name '*.c') | split-man.pl /tmp/man
+$ scripts/kernel-doc -man $(find -name '*.c' '*.h') | split-man.pl /tmp/man
 
 Here is split-man.pl:
 
@@ -122,6 +122,25 @@
 '%CONST' - name of a constant.
 
 Take a look around the source tree for examples.
+
+
+How to make new SGML template files
+-----------------------------------
+
+SGML template files (*.tmpl) are like normal SGML files, except that
+they can contain escape sequences where extracted documentation should
+be inserted.
+
+!E<filename> is replaced by the documentation, in <filename>, for
+functions that are exported using EXPORT_SYMBOL: the function list is
+collected from files listed in Documentation/DocBook/Makefile.
+
+!I<filename> is replaced by the documentation for functions that are
+_not_ exported using EXPORT_SYMBOL.
+
+!F<filename> <function [functions...]> is replaced by the
+documentation, in <filename>, for the functions listed.
+
 
 Tim.
 */ <twaugh@redhat.com>