linux-kernel - [PATCH] docbook: skip files with no docs since they generate scary warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Date:	Sat, 11 Sep 2010 15:55:26 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	lkml <linux-kernel@...r.kernel.org>
Cc:	torvalds <torvalds@...ux-foundation.org>
Subject: [PATCH] docbook: skip files with no docs since they generate scary
 warnings

From: Randy Dunlap <randy.dunlap@...cle.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@...cle.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>
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/