lkml.org 
[lkml]   [2010]   [Sep]   [11]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
Patch in this message
/
Date
From
Subject[PATCH] docbook: skip files with no docs since they generate scary warnings
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>

\
 
 \ /
  Last update: 2010-09-12 00:59    [W:0.055 / U:0.148 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site