Commit ff346687 authored by Craig Wilkie's avatar Craig Wilkie Committed by Linus Torvalds

[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."
parent 97dcccc6
...@@ -90,7 +90,7 @@ IMG-parportbook2 := $(addprefix $(obj)/,$(IMG-parportbook)) ...@@ -90,7 +90,7 @@ IMG-parportbook2 := $(addprefix $(obj)/,$(IMG-parportbook))
EPS-parportbook := $(patsubst %.fig,%.eps, $(IMG-parportbook2)) EPS-parportbook := $(patsubst %.fig,%.eps, $(IMG-parportbook2))
PNG-parportbook := $(patsubst %.fig,%.png, $(IMG-parportbook2)) PNG-parportbook := $(patsubst %.fig,%.png, $(IMG-parportbook2))
$(obj)/parportbook.html: $(PNG-parportbook) $(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 # Rules to generate postscript, PDF and HTML
......
...@@ -150,7 +150,12 @@ KAO --> ...@@ -150,7 +150,12 @@ KAO -->
!Ekernel/kmod.c !Ekernel/kmod.c
</sect1> </sect1>
<sect1><title>Inter Module support</title> <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> </sect1>
</chapter> </chapter>
...@@ -172,7 +177,12 @@ KAO --> ...@@ -172,7 +177,12 @@ KAO -->
</sect1> </sect1>
<sect1><title>MCA Architecture</title> <sect1><title>MCA Architecture</title>
<sect2><title>MCA Device Functions</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>
<sect2><title>MCA Bus DMA</title> <sect2><title>MCA Bus DMA</title>
!Iinclude/asm-i386/mca_dma.h !Iinclude/asm-i386/mca_dma.h
...@@ -213,7 +223,9 @@ KAO --> ...@@ -213,7 +223,9 @@ KAO -->
<chapter id="snddev"> <chapter id="snddev">
<title>Sound Devices</title> <title>Sound Devices</title>
!Esound/sound_core.c !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>
<chapter id="usb"> <chapter id="usb">
...@@ -292,7 +304,9 @@ KAO --> ...@@ -292,7 +304,9 @@ KAO -->
<sect1><title>USB Core APIs</title> <sect1><title>USB Core APIs</title>
!Edrivers/usb/core/urb.c !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/message.c
!Edrivers/usb/core/file.c !Edrivers/usb/core/file.c
!Edrivers/usb/core/usb.c !Edrivers/usb/core/usb.c
...@@ -385,7 +399,12 @@ KAO --> ...@@ -385,7 +399,12 @@ KAO -->
!Idrivers/video/macmodes.c !Idrivers/video/macmodes.c
</sect1> </sect1>
<sect1><title>Frame Buffer Fonts</title> <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> </sect1>
</chapter> </chapter>
<!-- Needs ksyms to list additional exported symbols, but no specific doc. <!-- Needs ksyms to list additional exported symbols, but no specific doc.
......
...@@ -111,7 +111,8 @@ struct obs_kernel_param { ...@@ -111,7 +111,8 @@ struct obs_kernel_param {
* *
* module_init() will either be called during do_initcalls (if * module_init() will either be called during do_initcalls (if
* builtin) or at module insertion time (if a module). There can only * 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); #define module_init(x) __initcall(x);
/** /**
......
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