diff options
| author | Craig Wilkie <craig@homerjay.homelinux.org> | 2003-01-05 04:55:47 -0800 |
|---|---|---|
| committer | Linus Torvalds <torvalds@home.transmeta.com> | 2003-01-05 04:55:47 -0800 |
| commit | ff346687f65023e29f9c8571c606fe8bb54027e3 (patch) | |
| tree | 2aee43010bed81f26b1f067becac5013b781d70b | |
| parent | 97dcccc6b52c037b2cf2644486f7120c08976f9e (diff) | |
[PATCH] Fix errors making Docbook documentation
This modifies the following files: -
Documentation/Docbook/Makefile - Fix dependencies generating parportbook
which caused tex to choke.
Documentation/Docbook/kernel-api.tmpl - Remove references to source
files which do not contain kernel-doc comments, which caused "errors" in
the generated documentation.
include/linux/init.h - fix a trivial function comment to correct the
generated documentation.
This patch partially addresses one of the issues on the Kernel Janitor
TODO list -
"someone who knows DocBook, or is willing to learn, should go through
and clean up Documentation/DocBook to kill all the warnings that occur
during "make pdfdocs" and generally make the documents look nicer, and
render smaller PDFs."
| -rw-r--r-- | Documentation/DocBook/Makefile | 2 | ||||
| -rw-r--r-- | Documentation/DocBook/kernel-api.tmpl | 29 | ||||
| -rw-r--r-- | include/linux/init.h | 3 |
3 files changed, 27 insertions, 7 deletions
diff --git a/Documentation/DocBook/Makefile b/Documentation/DocBook/Makefile index 11c194d9615d..4e689b702761 100644 --- a/Documentation/DocBook/Makefile +++ b/Documentation/DocBook/Makefile @@ -90,7 +90,7 @@ IMG-parportbook2 := $(addprefix $(obj)/,$(IMG-parportbook)) EPS-parportbook := $(patsubst %.fig,%.eps, $(IMG-parportbook2)) PNG-parportbook := $(patsubst %.fig,%.png, $(IMG-parportbook2)) $(obj)/parportbook.html: $(PNG-parportbook) -$(obj)/parportbook.ps $(obj)/parportbook.pdf: $(EPS-parportbook) +$(obj)/parportbook.ps $(obj)/parportbook.pdf: $(EPS-parportbook) $(PNG-parportbook) ### # Rules to generate postscript, PDF and HTML diff --git a/Documentation/DocBook/kernel-api.tmpl b/Documentation/DocBook/kernel-api.tmpl index f7b088432595..74dd7dd4a51f 100644 --- a/Documentation/DocBook/kernel-api.tmpl +++ b/Documentation/DocBook/kernel-api.tmpl @@ -150,7 +150,12 @@ KAO --> !Ekernel/kmod.c </sect1> <sect1><title>Inter Module support</title> -!Ekernel/module.c + <para> + Refer to the file kernel/module.c for more information. + </para> +<!-- FIXME: Removed for now since no structured comments in source +X!Ekernel/module.c +--> </sect1> </chapter> @@ -172,7 +177,12 @@ KAO --> </sect1> <sect1><title>MCA Architecture</title> <sect2><title>MCA Device Functions</title> -!Earch/i386/kernel/mca.c + <para> + Refer to the file arch/i386/kernel/mca.c for more information. + </para> +<!-- FIXME: Removed for now since no structured comments in source +X!Earch/i386/kernel/mca.c +--> </sect2> <sect2><title>MCA Bus DMA</title> !Iinclude/asm-i386/mca_dma.h @@ -213,7 +223,9 @@ KAO --> <chapter id="snddev"> <title>Sound Devices</title> !Esound/sound_core.c -!Isound/sound_firmware.c +<!-- FIXME: Removed for now since no structured comments in source +X!Isound/sound_firmware.c +--> </chapter> <chapter id="usb"> @@ -292,7 +304,9 @@ KAO --> <sect1><title>USB Core APIs</title> !Edrivers/usb/core/urb.c -!Edrivers/usb/core/config.c +<!-- FIXME: Removed for now since no structured comments in source +X!Edrivers/usb/core/config.c +--> !Edrivers/usb/core/message.c !Edrivers/usb/core/file.c !Edrivers/usb/core/usb.c @@ -385,7 +399,12 @@ KAO --> !Idrivers/video/macmodes.c </sect1> <sect1><title>Frame Buffer Fonts</title> -!Idrivers/video/console/fonts.c + <para> + Refer to the file drivers/video/console/fonts.c for more information. + </para> +<!-- FIXME: Removed for now since no structured comments in source +X!Idrivers/video/console/fonts.c +--> </sect1> </chapter> <!-- Needs ksyms to list additional exported symbols, but no specific doc. diff --git a/include/linux/init.h b/include/linux/init.h index b7c6363478aa..a3ad7dd1a38f 100644 --- a/include/linux/init.h +++ b/include/linux/init.h @@ -111,7 +111,8 @@ struct obs_kernel_param { * * module_init() will either be called during do_initcalls (if * builtin) or at module insertion time (if a module). There can only - * be one per module. */ + * be one per module. + */ #define module_init(x) __initcall(x); /** |
