Following patch updates the kernel doc nano HOWTO to inform readers that
htmldocs can be made directly, and documents one of the possible errors
that can be produced when miscoding comments for DocBook.
Applies cleanly to 2.4.10-pre4 and 2.4.9-ac6.
diff -urN linux-2.4.7/Documentation/kernel-doc-nano-HOWTO.txt altered-2.4.7/Documentation/kernel-doc-nano-HOWTO.txt
--- linux-2.4.7/Documentation/kernel-doc-nano-HOWTO.txt Sun Jun 3 20:44:38 2001
+++ altered-2.4.7/Documentation/kernel-doc-nano-HOWTO.txt Mon Aug 20 21:17:49 2001
@@ -35,9 +35,9 @@
- Makefile
- The targets 'sgmldocs', 'psdocs', and 'pdfdocs' are used to build
- DocBook files, PostScript files, and PDF files in
- Documentation/DocBook.
+ The targets 'sgmldocs', 'psdocs', 'pdfdocs', and 'htmldocs' are used
+ to build DocBook files, PostScript files, PDF files, and html files
+ in Documentation/DocBook.
- Documentation/DocBook/Makefile
@@ -49,10 +49,11 @@
If you just want to read the ready-made books on the various
subsystems (see Documentation/DocBook/*.tmpl), just type 'make
-psdocs', or 'make pdfdocs', depending on your preference. If you
-would rather read a different format, you can type 'make sgmldocs' and
-then use DocBook tools to convert Documentation/DocBook/*.sgml to a
-format of your choice (for example, 'db2html ...').
+psdocs', or 'make pdfdocs', or 'make htmldocs', depending on your
+preference. If you would rather read a different format, you can type
+'make sgmldocs' and then use DocBook tools to convert
+Documentation/DocBook/*.sgml to a format of your choice (for example,
+'db2html ...' if 'make htmldocs' was not defined).
If you want to see man pages instead, you can do this:
@@ -111,7 +112,9 @@
(*)?*/
The short function description cannot be multiline, but the other
-descriptions can be.
+descriptions can be (and they can contain blank lines). Avoid putting a
+spurious blank line after the function name, or else the description will
+be repeated!
All descriptive text is further processed, scanning for the following special
patterns, which are highlighted appropriately.
Ken
--
If a six turned out to be nine, I don't mind.
Home page : http://www.kenmoffat.uklinux.net
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
This archive was generated by hypermail 2b29 : Fri Sep 07 2001 - 21:00:32 EST