Commit 2b35f4d9 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

kernel-doc: escape xml for structs 



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: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 2811036a

scripts/kernel-doc

+9 −3
Original line number Diff line number Diff line
@@ -5,7 +5,7 @@ use strict; 
## Copyright (c) 1998 Michael Zucchi, All Rights Reserved        ##

## Copyright (C) 2000, 1  Tim Waugh <twaugh@redhat.com>          ##

## 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>	 ##

## Copyright (c) 2000 MontaVista Software, Inc.			 ##
@@ -453,7 +453,7 @@ sub output_highlight { 
    if ($output_mode eq "html" || $output_mode eq "xml") {

	$contents = local_unescape($contents);

	# convert data read & converted thru xml_escape() into &xyz; format:

	$contents =~ s/\\\\\\/&/g;

	$contents =~ s/\\\\\\/\&/g;

    }

#   print STDERR "contents b4:$contents\n";

    eval $dohighlight;
@@ -770,7 +770,11 @@ sub output_struct_xml(%) { 
    print $args{'type'} . " " . $args{'struct'} . " {\n";

    foreach $parameter (@{$args{'parameterlist'}}) {

	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;

	}
@@ -1701,6 +1705,8 @@ sub push_parameter($$$) { 
	}

	}



	$param = xml_escape($param);



	# strip spaces from $param so that it is one continous string

	# on @parameterlist;

	# this fixes a problem where check_sections() cannot find

CRA Git | Maintained and supported by SUSTech CRA and CCSE