All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH] docbook: skip files with no docs since they generate scary warnings
@ 2010-09-11 22:55 Randy Dunlap
  0 siblings, 0 replies; only message in thread
From: Randy Dunlap @ 2010-09-11 22:55 UTC (permalink / raw)
  To: lkml; +Cc: torvalds

From: Randy Dunlap <randy.dunlap@oracle.com>

Fix docbook templates that reference files that do not
contain the expected kernel-doc notation.

Fixes these warnings:

Warning(arch/x86/include/asm/unaligned.h): no structured comments found
Warning(lib/vsprintf.c): no structured comments found

These cause errors in the generated html output, like below,
so drop these lines.

Name
lnx-2636-rc3//arch/x86/include/asm/unaligned.h - Document generation inconsistency
Oops
Warning
The template for this document tried to insert the structured comment from the file lnx-2636-rc3//arch/x86/include/asm/unaligned.h at this point, but none was found. This dummy section is inserted to allow generation to continue.

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
---
 Documentation/DocBook/device-drivers.tmpl |    1 -
 Documentation/DocBook/kernel-api.tmpl     |    1 -
 2 files changed, 2 deletions(-)

--- lnx-2636-rc3.orig/Documentation/DocBook/device-drivers.tmpl
+++ lnx-2636-rc3/Documentation/DocBook/device-drivers.tmpl
@@ -46,7 +46,6 @@
 
      <sect1><title>Atomic and pointer manipulation</title>
 !Iarch/x86/include/asm/atomic.h
-!Iarch/x86/include/asm/unaligned.h
      </sect1>
 
      <sect1><title>Delaying, scheduling, and timer routines</title>
--- lnx-2636-rc3.orig/Documentation/DocBook/kernel-api.tmpl
+++ lnx-2636-rc3/Documentation/DocBook/kernel-api.tmpl
@@ -57,7 +57,6 @@
      </para>
 
      <sect1><title>String Conversions</title>
-!Ilib/vsprintf.c
 !Elib/vsprintf.c
      </sect1>
      <sect1><title>String Manipulation</title>

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2010-09-11 22:57 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2010-09-11 22:55 [PATCH] docbook: skip files with no docs since they generate scary warnings Randy Dunlap

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.