All of lore.kernel.org
 help / color / mirror / Atom feed
* [for review: PATCH 1/8] kernel-doc: escape xml for structs
@ 2010-11-10 19:53 Randy Dunlap
  2010-11-10 19:53 ` [PATCH 2/8] Documentation: make configfs example code simpler, clearer Randy Dunlap
                   ` (6 more replies)
  0 siblings, 7 replies; 9+ messages in thread
From: Randy Dunlap @ 2010-11-10 19:53 UTC (permalink / raw)
  To: linux-kernel

From: Randy Dunlap <randy.dunlap@oracle.com>

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>
---
 scripts/kernel-doc |   12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

--- linux-2.6.37-rc1-git8.orig/scripts/kernel-doc
+++ linux-2.6.37-rc1-git8/scripts/kernel-doc
@@ -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


-- 


^ permalink raw reply	[flat|nested] 9+ messages in thread
end of thread, other threads:[~2010-11-11 11:10 UTC | newest]

Thread overview: 9+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-11-10 19:53 [for review: PATCH 1/8] kernel-doc: escape xml for structs Randy Dunlap
2010-11-10 19:53 ` [PATCH 2/8] Documentation: make configfs example code simpler, clearer Randy Dunlap
2010-11-10 19:53 ` [PATCH 3/8] Documentation/gpio.txt: explain poll/select usage Randy Dunlap
2010-11-10 19:53 ` [PATCH 7/8] Documentation: remove anticipatory scheduler info Randy Dunlap
2010-11-11 11:10   ` Jens Axboe
2010-11-10 19:53 ` [PATCH 5/8] Documentation/development-process: use -next trees instead of staging Randy Dunlap
2010-11-10 19:53 ` [PATCH 4/8] Documentation: change email address for Hans Koch Randy Dunlap
2010-11-10 19:53 ` [PATCH 8/8] MAINTAINERS: update documentation entries Randy Dunlap
2010-11-10 19:53 ` [PATCH 6/8] Documentation/development-process: more staging info Randy Dunlap

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.