Skip to contentSkip to conversation

docbook: skip files with no docs since they generate scary warnings

PATCH New Randy Dunlap 1 participant 1 message Sep 11, 2010 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 docbook: skip files with no docs since they generate scary warnings

From: Randy Dunlap <[email protected]>

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.

---
 Documentation/DocBook/device-drivers.tmpl |    1 -
 Documentation/DocBook/kernel-api.tmpl     |    1 -
 2 files changed, 2 deletions(-)
Documentation/DocBook/device-drivers.tmpl +0 -1
@@ -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>
Documentation/DocBook/kernel-api.tmpl +0 -1
@@ -57,7 +57,6 @@
      </para>
 
      <sect1><title>String Conversions</title>
-!Ilib/vsprintf.c
 !Elib/vsprintf.c
      </sect1>
      <sect1><title>String Manipulation</title>