lk/linux-kernel-test
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

kernel-doc: escape xml for structs

Browse Source 
scripts/kernel-doc was leaving unescaped '<', '>', and '&' in
generated xml output for structs.  This causes xml parser errors.
Convert these characters to "&lt;", "&gt;", and "&amp;" as needed
to prevent errors.

Most of the conversion was already done; complete it just before
output.

Documentation/DocBook/device-drivers.xml:41883: parser error : StartTag: invalid element name
#define INPUT_KEYMAP_BY_INDEX	(1 << 0)

Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
This commit is contained in:
Randy Dunlap
2010-11-18 12:27:31 -08:00
committed by Linus Torvalds
parent 2811036a19
commit 2b35f4d9ca
1 changed files with 9 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
scripts/kernel-doc
View File

@@ -5,7 +5,7 @@ use strict;
## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ## ## Copyright (c) 1998 Michael Zucchi, All Rights Reserved ##
## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ## ## Copyright (C) 2000, 1 Tim Waugh <twaugh@redhat.com> ##
## Copyright (C) 2001 Simon Huggins ## ## Copyright (C) 2001 Simon Huggins ##
## Copyright (C) 2005-2009 Randy Dunlap ## ## Copyright (C) 2005-2010 Randy Dunlap ##
## ## ## ##
## #define enhancements by Armin Kuster <akuster@mvista.com> ## ## #define enhancements by Armin Kuster <akuster@mvista.com> ##
## Copyright (c) 2000 MontaVista Software, Inc. ## ## Copyright (c) 2000 MontaVista Software, Inc. ##
@@ -453,7 +453,7 @@ sub output_highlight {
if ($output_mode eq "html" || $output_mode eq "xml") { if ($output_mode eq "html" || $output_mode eq "xml") {
$contents = local_unescape($contents); $contents = local_unescape($contents);
# convert data read & converted thru xml_escape() into &xyz; format: # convert data read & converted thru xml_escape() into &xyz; format:
$contents =~ s/\\\\\\/&/g; $contents =~ s/\\\\\\/\&/g;
} }
# print STDERR "contents b4:$contents\n"; # print STDERR "contents b4:$contents\n";
eval $dohighlight; eval $dohighlight;
@@ -770,7 +770,11 @@ sub output_struct_xml(%) {
print $args{'type'} . " " . $args{'struct'} . " {\n"; print $args{'type'} . " " . $args{'struct'} . " {\n";
foreach $parameter (@{$args{'parameterlist'}}) { foreach $parameter (@{$args{'parameterlist'}}) {
if ($parameter =~ /^#/) { if ($parameter =~ /^#/) {
print "$parameter\n"; my $prm = $parameter;
# convert data read & converted thru xml_escape() into &xyz; format:
# This allows us to have #define macros interspersed in a struct.
$prm =~ s/\\\\\\/\&/g;
print "$prm\n";
next; next;
} }
@@ -1701,6 +1705,8 @@ sub push_parameter($$$) {
} }
} }
$param = xml_escape($param);
# strip spaces from $param so that it is one continous string # strip spaces from $param so that it is one continous string
# on @parameterlist; # on @parameterlist;
# this fixes a problem where check_sections() cannot find # this fixes a problem where check_sections() cannot find