[PATCH] kernel-doc: allow structs whose members are all private

From: Randy Dunlap
Date: Mon Sep 15 2008 - 13:03:31 EST


From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

Fix kernel-doc to handle structs whose members are all private;
otherwise invalid XML is generated:

xmlto: input does not validate (status 3)
linux-2.6.27-rc6-git4/Documentation/DocBook/debugobjects.xml:146: element variablelist: validity error : Element variablelist content does not follow the DTD, expecting ((title , titleabbrev?)? , varlistentry+), got ()
Document linux-2.6.27-rc6-git4/Documentation/DocBook/debugobjects.xml does not validate
make[1]: *** [Documentation/DocBook/debugobjects.html] Error 3

Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>
Reported-by: Roland McGrath <roland@xxxxxxxxxx>
cc: Roland McGrath <roland@xxxxxxxxxx>
cc: Christoph Hellwig <hch@xxxxxxxxxxxxx>
---
scripts/kernel-doc | 4 ++++
1 file changed, 4 insertions(+)

--- linux-2.6.27-rc6-git4.orig/scripts/kernel-doc
+++ linux-2.6.27-rc6-git4/scripts/kernel-doc
@@ -781,6 +781,7 @@ sub output_struct_xml(%) {
print " <refsect1>\n";
print " <title>Members</title>\n";

+ if ($#{$args{'parameterlist'}} >= 0) {
print " <variablelist>\n";
foreach $parameter (@{$args{'parameterlist'}}) {
($parameter =~ /^#/) && next;
@@ -798,6 +799,9 @@ sub output_struct_xml(%) {
print " </varlistentry>\n";
}
print " </variablelist>\n";
+ } else {
+ print " <para>\n None\n </para>\n";
+ }
print " </refsect1>\n";

output_section_xml(@_);
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/