Commit b7b2f983 authored by Sam Ravnborg's avatar Sam Ravnborg Committed by Linus Torvalds

[PATCH] docbook: Update documentation to reflect new docproc [7/9]

kernel-doc-nano-HOWTO.txt updated to reflect new functionality
provided by docproc.
gen-all-syms and docgen description removed.
kernel-api.tmpl and parportbook.tmpl updated to specify files to search
for EXPORT-SYMBOL* to enable documentation of all relevant functions.
parent 7f23c245
...@@ -50,7 +50,7 @@ ...@@ -50,7 +50,7 @@
kernel/sched.c has no docs, which stuffs up the sgml. Comment kernel/sched.c has no docs, which stuffs up the sgml. Comment
out until somebody adds docs. KAO out until somebody adds docs. KAO
<sect1><title>Delaying, scheduling, and timer routines</title> <sect1><title>Delaying, scheduling, and timer routines</title>
!Ekernel/sched.c X!Ekernel/sched.c
</sect1> </sect1>
KAO --> KAO -->
</chapter> </chapter>
...@@ -367,7 +367,7 @@ KAO --> ...@@ -367,7 +367,7 @@ KAO -->
drivers/video/fbgen.c has no docs, which stuffs up the sgml. Comment drivers/video/fbgen.c has no docs, which stuffs up the sgml. Comment
out until somebody adds docs. KAO out until somebody adds docs. KAO
<sect1><title>Frame Buffer Generic Functions</title> <sect1><title>Frame Buffer Generic Functions</title>
!Idrivers/video/fbgen.c X!Idrivers/video/fbgen.c
</sect1> </sect1>
KAO --> KAO -->
<sect1><title>Frame Buffer Video Mode Database</title> <sect1><title>Frame Buffer Video Mode Database</title>
...@@ -381,5 +381,9 @@ KAO --> ...@@ -381,5 +381,9 @@ KAO -->
!Idrivers/video/fonts.c !Idrivers/video/fonts.c
</sect1> </sect1>
</chapter> </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> </book>
...@@ -2729,7 +2729,9 @@ to permit their use in free software. ...@@ -2729,7 +2729,9 @@ to permit their use in free software.
</appendix> </appendix>
</book> </book>
<!-- Additional function to be documented:
!Ddrivers/parport/init.c
-->
<!-- Local Variables: --> <!-- Local Variables: -->
<!-- sgml-indent-step: 1 --> <!-- sgml-indent-step: 1 -->
<!-- sgml-indent-data: 1 --> <!-- sgml-indent-data: 1 -->
......
...@@ -20,18 +20,14 @@ are: ...@@ -20,18 +20,14 @@ are:
- scripts/docproc.c - scripts/docproc.c
This is a program for converting SGML template files into SGML 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. are to be documented.
Additionally it is used to scan the SGML template files to locate
- scripts/gen-all-syms all the files referenced herein. This is used to generate dependency
information as used by make.
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).
- Makefile - Makefile
...@@ -142,6 +138,10 @@ collected from files listed in Documentation/DocBook/Makefile. ...@@ -142,6 +138,10 @@ collected from files listed in Documentation/DocBook/Makefile.
!I<filename> is replaced by the documentation for functions that are !I<filename> is replaced by the documentation for functions that are
_not_ exported using EXPORT_SYMBOL. _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 !F<filename> <function [functions...]> is replaced by the
documentation, in <filename>, for the functions listed. documentation, in <filename>, for the functions listed.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment