Commit 39f00c08 authored Sep 22, 2008 by Randy Dunlap Committed by Linus Torvalds Sep 23, 2008

kernel-doc: allow structs whose members are all private



Struct members may be marked as private by using
	/* private: */
before them, as noted in Documentation/kernel-doc-nano-HOWTO.txt

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@oracle.com>
Reported-by: Roland McGrath <roland@redhat.com>
Cc: Roland McGrath <roland@redhat.com>
Cc: Christoph Hellwig <hch@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

parent c32a162f

scripts/kernel-doc

+4 −0

Original line number	Diff line number	Diff line
		@@ -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(@_);

Admin message