From patchwork Wed Feb 14 18:40:02 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Jonathan Corbet X-Patchwork-Id: 128376 Delivered-To: patch@linaro.org Received: by 10.46.124.24 with SMTP id x24csp911606ljc; Wed, 14 Feb 2018 10:40:40 -0800 (PST) X-Google-Smtp-Source: AH8x225zHTgdAu8YFABXYc+gyhC6crQcyPan/xFfz51z1+X4vXXmJBynP7gQIRUd747TeJwghB3O X-Received: by 2002:a17:902:bf0a:: with SMTP id bi10-v6mr68320plb.181.1518633640344; Wed, 14 Feb 2018 10:40:40 -0800 (PST) ARC-Seal: i=1; a=rsa-sha256; t=1518633640; cv=none; d=google.com; s=arc-20160816; b=FphqbFO/1wWoah8kDbV6bqvZYAafFZN+53VQtMyK6tWYCukEVUumcPBrib4D/6hIQI 5jBhxi2KzwRRj1wwf5q8wSYSaHdqGXydhWpDiDG1Pslyc+B0dhllWrNbgVWgb9t/sjUp nmSAWysQimwnxRZ9hdVI4vTUFupX+6yh8W4AVG08JL5S4Dpm5oidwMZOszpAD4bhw/s9 qtogxNujmUaZ/i4HI6yIetW5s2JCxJaOvhe+n+/Ld0T2TrXOzOabUcH/x4p0iYHCG5ux c3BtJf4tYEoWC9opA5mxh8cLxKYozrKgjL0utipmIjYOkUY0Do+1iq8i46ceeRdK352Z IjnA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:sender:references:in-reply-to:message-id:date :subject:cc:to:from:arc-authentication-results; bh=mzHdl7Kl0kYH6ZnVQYW4MRSAXUDVtc5YThl1WAlyrHM=; b=WuVwAb80wQZXsTiDWmBcu79d8EQUdUsMiWOYg/Bm6W4BX0/J+P8TFIfcKpJDIW9uj8 GrAOKX0MXCIA7xfIfBsBAlIJxOTXkpUhiWe8x4hL6OOzq16Jya5JrHPGsCUmkw00fgv1 q9OgLQfx4osA2qjRPwU64I4Hn/fz/aE5k/Lnqy43weWBqHoEvVVqvb+aCZorupd7XulU gTbHj81hiW6RAU0HGZEy/iLs6GESCaZ5DSap8pnqnmcFehGjviuMlD5X6o1UY0FZpYc4 2p++Eq04wgdxKUHQ2fsustYH5wUZLBOA8Pjn4J+WAdQWrq5r4PsGSGwbKz3RJMivNcoM kl5g== ARC-Authentication-Results: i=1; mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Return-Path: Received: from vger.kernel.org (vger.kernel.org. [209.132.180.67]) by mx.google.com with ESMTP id j2-v6si1558312plk.264.2018.02.14.10.40.39; Wed, 14 Feb 2018 10:40:40 -0800 (PST) Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67; Authentication-Results: mx.google.com; spf=pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1162235AbeBNSke (ORCPT + 28 others); Wed, 14 Feb 2018 13:40:34 -0500 Received: from ms.lwn.net ([45.79.88.28]:54642 "EHLO ms.lwn.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1161773AbeBNSk3 (ORCPT ); Wed, 14 Feb 2018 13:40:29 -0500 Received: from tpad.lan (localhost [127.0.0.1]) by ms.lwn.net (Postfix) with ESMTPA id AD5C62E7; Wed, 14 Feb 2018 18:40:28 +0000 (UTC) From: Jonathan Corbet To: linux-doc@vger.kernel.org Cc: linux-kernel@vger.kernel.org, mchehab@kernel.org, me@tobin.cc, jani.nikula@linux.intel.com, Jonathan Corbet Subject: [PATCH 1/8] docs: kernel-doc: Get rid of xml_escape() and friends Date: Wed, 14 Feb 2018 11:40:02 -0700 Message-Id: <20180214184009.12657-2-corbet@lwn.net> X-Mailer: git-send-email 2.14.3 In-Reply-To: <20180214184009.12657-1-corbet@lwn.net> References: <20180214184009.12657-1-corbet@lwn.net> Sender: linux-kernel-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org XML escaping is a worry that came with DocBook, which we no longer have any dealings with. So get rid of the useless xml_escape()/xml_unescape() functions. No change to the generated output. Signed-off-by: Jonathan Corbet --- scripts/kernel-doc | 65 ++++++++---------------------------------------------- 1 file changed, 9 insertions(+), 56 deletions(-) -- 2.14.3 Reviewed-by: Jani Nikula diff --git a/scripts/kernel-doc b/scripts/kernel-doc index fee8952037b1..5aa4ce211fc6 100755 --- a/scripts/kernel-doc +++ b/scripts/kernel-doc @@ -553,10 +553,9 @@ sub output_highlight { } if ($line eq ""){ if (! $output_preformatted) { - print $lineprefix, local_unescape($blankline); + print $lineprefix, $blankline; } } else { - $line =~ s/\\\\\\/\&/g; if ($output_mode eq "man" && substr($line, 0, 1) eq ".") { print "\\&$line"; } else { @@ -751,9 +750,6 @@ sub output_highlight_rst { my $contents = join "\n",@_; my $line; - # undo the evil effects of xml_escape() earlier - $contents = xml_unescape($contents); - eval $dohighlight; die $@ if $@; @@ -1422,8 +1418,6 @@ sub push_parameter($$$$) { } } - $param = xml_escape($param); - # strip spaces from $param so that it is one continuous string # on @parameterlist; # this fixes a problem where check_sections() cannot find @@ -1748,47 +1742,6 @@ sub process_proto_type($$) { } } -# xml_escape: replace <, >, and & in the text stream; -# -# however, formatting controls that are generated internally/locally in the -# kernel-doc script are not escaped here; instead, they begin life like -# $blankline_html (4 of '\' followed by a mnemonic + ':'), then these strings -# are converted to their mnemonic-expected output, without the 4 * '\' & ':', -# just before actual output; (this is done by local_unescape()) -sub xml_escape($) { - my $text = shift; - if ($output_mode eq "man") { - return $text; - } - $text =~ s/\&/\\\\\\amp;/g; - $text =~ s/\/\\\\\\gt;/g; - return $text; -} - -# xml_unescape: reverse the effects of xml_escape -sub xml_unescape($) { - my $text = shift; - if ($output_mode eq "man") { - return $text; - } - $text =~ s/\\\\\\amp;/\&/g; - $text =~ s/\\\\\\lt;//g; - return $text; -} - -# convert local escape strings to html -# local escape strings look like: '\\\\menmonic:' (that's 4 backslashes) -sub local_unescape($) { - my $text = shift; - if ($output_mode eq "man") { - return $text; - } - $text =~ s/\\\\\\\\lt://g; - return $text; -} sub map_filename($) { my $file; @@ -1889,7 +1842,7 @@ sub process_file($) { $descr =~ s/^\s*//; $descr =~ s/\s*$//; $descr =~ s/\s+/ /g; - $declaration_purpose = xml_escape($descr); + $declaration_purpose = $descr; $in_purpose = 1; } else { $declaration_purpose = ""; @@ -1944,7 +1897,7 @@ sub process_file($) { print STDERR "${file}:$.: warning: contents before sections\n"; ++$warnings; } - dump_section($file, $section, xml_escape($contents)); + dump_section($file, $section, $contents); $section = $section_default; } @@ -1962,7 +1915,7 @@ sub process_file($) { $leading_space = undef; } elsif (/$doc_end/) { if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, xml_escape($contents)); + dump_section($file, $section, $contents); $section = $section_default; $contents = ""; } @@ -1981,7 +1934,7 @@ sub process_file($) { # @parameter line to signify start of description if ($1 eq "") { if ($section =~ m/^@/ || $section eq $section_context) { - dump_section($file, $section, xml_escape($contents)); + dump_section($file, $section, $contents); $section = $section_default; $contents = ""; $new_start_line = $.; @@ -1992,7 +1945,7 @@ sub process_file($) { } elsif ($in_purpose == 1) { # Continued declaration purpose chomp($declaration_purpose); - $declaration_purpose .= " " . xml_escape($1); + $declaration_purpose .= " " . $1; $declaration_purpose =~ s/\s+/ /g; } else { my $cont = $1; @@ -2030,7 +1983,7 @@ sub process_file($) { # Documentation block end */ } elsif (/$doc_inline_end/) { if (($contents ne "") && ($contents ne "\n")) { - dump_section($file, $section, xml_escape($contents)); + dump_section($file, $section, $contents); $section = $section_default; $contents = ""; } @@ -2057,7 +2010,7 @@ sub process_file($) { $contents = $2; if ($contents ne "") { $contents .= "\n"; - dump_section($file, $section, xml_escape($contents)); + dump_section($file, $section, $contents); $section = $section_default; $contents = ""; } @@ -2072,7 +2025,7 @@ sub process_file($) { } elsif ($state == STATE_DOCBLOCK) { if (/$doc_end/) { - dump_doc_section($file, $section, xml_escape($contents)); + dump_doc_section($file, $section, $contents); $section = $section_default; $contents = ""; $function = "";