diff options
Diffstat (limited to 'Documentation/kernel-doc-nano-HOWTO.txt')
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 21 |
1 files changed, 20 insertions, 1 deletions
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 585d557ab..228a0602d 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt @@ -57,7 +57,7 @@ format of your choice (for example, 'db2html ...'). 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: @@ -123,6 +123,25 @@ patterns, which are highlighted appropriately. 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> |