diff options
| -rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 10 | ||||
| -rw-r--r-- | Documentation/DocBook/parportbook.tmpl | 4 | ||||
| -rw-r--r-- | Documentation/kernel-doc-nano-HOWTO.txt | 22 |
3 files changed, 21 insertions, 15 deletions
diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index 1f9d6d520e55..39a9c8aee6ee 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl @@ -50,7 +50,7 @@ kernel/sched.c has no docs, which stuffs up the sgml. Comment out until somebody adds docs. KAO <sect1><title>Delaying, scheduling, and timer routines</title> -!Ekernel/sched.c +X!Ekernel/sched.c </sect1> KAO --> </chapter> @@ -367,7 +367,7 @@ KAO --> drivers/video/fbgen.c has no docs, which stuffs up the sgml. Comment out until somebody adds docs. KAO <sect1><title>Frame Buffer Generic Functions</title> -!Idrivers/video/fbgen.c +X!Idrivers/video/fbgen.c </sect1> KAO --> <sect1><title>Frame Buffer Video Mode Database</title> @@ -381,5 +381,9 @@ KAO --> !Idrivers/video/fonts.c </sect1> </chapter> - +<!-- Needs ksyms to list additional exported symbols, but no specific doc. + docproc do not care about sgml commants. +!Dkernel/ksyms.c +!Dnet/netsyms.c +--> </book> diff --git a/Documentation/DocBook/parportbook.tmpl b/Documentation/DocBook/parportbook.tmpl index 575bb48747c5..89a1529accfc 100644 --- a/Documentation/DocBook/parportbook.tmpl +++ b/Documentation/DocBook/parportbook.tmpl @@ -2729,7 +2729,9 @@ to permit their use in free software. </appendix> </book> - +<!-- Additional function to be documented: +!Ddrivers/parport/init.c +--> <!-- Local Variables: --> <!-- sgml-indent-step: 1 --> <!-- sgml-indent-data: 1 --> diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt index 03ee7b1270f4..bea73ad9347c 100644 --- a/Documentation/kernel-doc-nano-HOWTO.txt +++ b/Documentation/kernel-doc-nano-HOWTO.txt @@ -20,18 +20,14 @@ are: - scripts/docproc.c This is a program for converting SGML template files into SGML - files. It invokes kernel-doc, giving it the list of functions that + files. When a file is referenced it is searched for symbols + exported (EXPORT_SYMBOL), to be able to distingush between internal + and external functions. + It invokes kernel-doc, giving it the list of functions that are to be documented. - -- scripts/gen-all-syms - - This is a script that lists the EXPORT_SYMBOL symbols in a list of C - files. - -- scripts/docgen - - This script invokes docproc, telling it which functions are to be - documented (this list comes from gen-all-syms). + Additionally it is used to scan the SGML template files to locate + all the files referenced herein. This is used to generate dependency + information as used by make. - Makefile @@ -142,6 +138,10 @@ collected from files listed in Documentation/DocBook/Makefile. !I<filename> is replaced by the documentation for functions that are _not_ exported using EXPORT_SYMBOL. +!D<filename> is used to name additional files to search for functions +exported using EXPORT_SYMBOL. For example many symbols are only exported +in kernel/ksyms.c, therefore kernel-api.sgml include this file with !D. + !F<filename> <function [functions...]> is replaced by the documentation, in <filename>, for the functions listed. |