Import latest version of texi2pod.pl from FSF GCC sources.
authorNick Clifton <nickc@redhat.com>
Tue, 11 Jun 2002 15:34:33 +0000 (15:34 +0000)
committerNick Clifton <nickc@redhat.com>
Tue, 11 Jun 2002 15:34:33 +0000 (15:34 +0000)
etc/ChangeLog
etc/texi2pod.pl

index 6b13bfdb6c10714478d9f2c40b6688e5d2f58287..debe735ca99f2b965d56251f187626c3712db979 100644 (file)
@@ -1,3 +1,31 @@
+2002-06-11  Nick Clifton  <nickc@cambridge.redhat.com>
+
+       Import the following patches from the FSF GCC sources:
+       2002-03-25  Zack Weinberg  <zack@codesourcery.com>
+
+       * texi2pod.pl: Handle @end ftable and @end vtable.
+
+       2001-12-12  Matthias Klose  <doko@debian.org>
+
+       * texi2pod.pl: Merge changes from binutils' texi2pod.pl. Allows
+       generation of more than one man page from one source.
+       Add '-' to set of valid chars for an identifier.
+       Let -D option accept flags of the form <flag>=<value>.
+       Use \s+ for whitespace detection in '@c man' lines.
+       Handle @set and @clear independent of $output.
+       Substitute all @value{}'s in a line.
+
+       2001-11-14  Joseph S. Myers  <jsm28@cam.ac.uk>
+
+       * texi2pod.pl: Handle @ifnottex, @iftex and @display.  Handle @var
+       in verbatim blocks specially.  Handle @unnumbered, @unnumberedsec
+       and @center.  Allow [a-z] after @enumerate.  Handle 0 and numbers
+       greater than 9 in enumerations.
+
+       2001-07-03  Joseph S. Myers  <jsm28@cam.ac.uk>
+
+       * texi2pod.pl: Handle @r inside @item.
+
 2002-02-27  Andrew Cagney  <ac131313@redhat.com>
 
        * fdl.texi: New file.
@@ -19,7 +47,7 @@
 
        * add-log.el, add-log.vi: New files.
 
-Wed Jan 20 01:33:50 1999  Angela Marie Thomas (angela@cygnus.com)
+1999-01-20  Angela Marie Thomas (angela@cygnus.com)
 
        * comp-tools-verify: Remove some checks that are no longer valid.
 
@@ -27,16 +55,16 @@ Wed Jan 20 01:33:50 1999  Angela Marie Thomas (angela@cygnus.com)
 
        * targetdoc/fr30.texi: New document.
        
-Thu Oct  1 21:15:59 1998  Angela Marie Thomas (angela@cygnus.com)
+1998-10-01  Angela Marie Thomas (angela@cygnus.com)
 
        * comp-tools-fix, cross-tools-fix: Replace /usr/include
        with ${FIXINCDIR}.
 
-Tue Aug 11 19:22:11 1998  Doug Evans  <devans@canuck.cygnus.com>
+1998-08-11  Doug Evans  <devans@canuck.cygnus.com>
 
        * make-rel-sym-tree (version): Update calculation.
 
-Fri Jun 12 21:34:01 1998  Ian Lance Taylor  <ian@cygnus.com>
+1998-06-12  Ian Lance Taylor  <ian@cygnus.com>
 
        * configure.texi: Various additions.
        * Makefile.in (TEXI2HTML, DVIPS): New variables.
@@ -51,7 +79,7 @@ Fri Jun 12 21:34:01 1998  Ian Lance Taylor  <ian@cygnus.com>
        * configbuild.ein: New file (EPS version of configbuild.fig).
        * configbuild.jin: New file (JPEG version of configbuild.fig).
 
-Wed Jun 10 14:41:25 1998  Ian Lance Taylor  <ian@cygnus.com>
+1998-06-10  Ian Lance Taylor  <ian@cygnus.com>
 
        * configure.texi: New file.
        * configdev.tin: New file.
index e6ad9f92d503dd631d6bec38551de02fcb4e64b2..bdc20e8118f3b48d087c6eda4745defd158c82e2 100644 (file)
@@ -1,6 +1,6 @@
 #! /usr/bin/perl -w
 
-#   Copyright (C) 1999, 2000, 2001 Free Software Foundation, Inc.
+#   Copyright (C) 1999, 2000, 2001, 200 Free Software Foundation, Inc.
 
 # This file is part of GNU CC.
 
@@ -30,9 +30,12 @@ $section = "";
 @icstack = ();
 @endwstack = ();
 @skstack = ();
+@instack = ();
 $shift = "";
 %defs = ();
 $fnno = 1;
+$inf = "";
+$ibase = "";
 
 while ($_ = shift) {
     if (/^-D(.*)$/) {
@@ -41,15 +44,13 @@ while ($_ = shift) {
        } else {
            $flag = shift;
        }
-       $value=$flag;
-       $value =~ s,^[a-zA-Z0-9_]+,,;
-       $value =~ s,.*=,,;
-       $flag =~ s,=.*$,,;
+       $value = "";
+       ($flag, $value) = ($flag =~ /^([^=]+)(?:=(.+))?/);
        die "no flag specified for -D\n"
            unless $flag ne "";
-       #print STDERR "FL = $flag, V = $value\n";
+       die "flags may only contain letters, digits, hyphens, dashes and underscores\n"
+           unless $flag =~ /^[a-zA-Z0-9_-]+$/;
        $defs{$flag} = $value;
-
     } elsif (/^-/) {
        usage();
     } else {
@@ -60,14 +61,19 @@ while ($_ = shift) {
 }
 
 if (defined $in) {
-    open(STDIN, $in) or die "opening \"$in\": $!\n";
+    $inf = gensym();
+    open($inf, "<$in") or die "opening \"$in\": $!\n";
+    $ibase = $1 if $in =~ m|^(.+)/[^/]+$|;
+} else {
+    $inf = \*STDIN;
 }
+
 if (defined $out) {
     open(STDOUT, ">$out") or die "opening \"$out\": $!\n";
 }
 
-while(<STDIN>)
-{
+while(defined $inf) {
+while(<$inf>) {
     # Certain commands are discarded without further processing.
     /^\@(?:
         [a-z]+index            # @*index: useful only in complete manual
@@ -75,8 +81,9 @@ while(<STDIN>)
         |(?:end\s+)?group      # @group .. @end group: ditto
         |page                  # @page: ditto
         |node                  # @node: useful only in .info file
+        |(?:end\s+)?ifnottex   # @ifnottex .. @end ifnottex: use contents
        )\b/x and next;
-    
+
     chomp;
 
     # Look for filename and title markers.
@@ -84,7 +91,7 @@ while(<STDIN>)
     /^\@settitle\s+([^.]+)/ and $tl = postprocess($1), next;
 
     # Identify a man title but keep only the one we are interested in.
-    /^\@c man title ([A-Za-z0-9]+) (.+)/ and do {
+    /^\@c\s+man\s+title\s+([A-Za-z0-9-]+)\s+(.+)/ and do {
        if (exists $defs{$1}) {
            $fn = $1;
            $tl = postprocess($2);
@@ -95,19 +102,30 @@ while(<STDIN>)
     # Look for blocks surrounded by @c man begin SECTION ... @c man end.
     # This really oughta be @ifman ... @end ifman and the like, but such
     # would require rev'ing all other Texinfo translators.
-    /^\@c man begin ([A-Z]+) ([A-Za-z0-9]+)/ and do {
+    /^\@c\s+man\s+begin\s+([A-Z]+)\s+([A-Za-z0-9-]+)/ and do {
        $output = 1 if exists $defs{$2};
         $sect = $1;
        next;
     };
-    /^\@c man begin ([A-Z]+)/ and $sect = $1, $output = 1, next;
-    /^\@c man end/ and do {
+    /^\@c\s+man\s+begin\s+([A-Z]+)/ and $sect = $1, $output = 1, next;
+    /^\@c\s+man\s+end/ and do {
        $sects{$sect} = "" unless exists $sects{$sect};
        $sects{$sect} .= postprocess($section);
        $section = "";
        $output = 0;
        next;
     };
+
+    # handle variables
+    /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and do {
+       $defs{$1} = $2;
+       next;
+    };
+    /^\@clear\s+([a-zA-Z0-9_-]+)/ and do {
+       delete $defs{$1};
+       next;
+    };
+
     next unless $output;
 
     # Discard comments.  (Can't do it above, because then we'd never see
@@ -120,20 +138,20 @@ while(<STDIN>)
        # Ignore @end foo, where foo is not an operation which may
        # cause us to skip, if we are presently skipping.
        my $ended = $1;
-       next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu)$/;
+       next if $skipping && $ended !~ /^(?:ifset|ifclear|ignore|menu|iftex)$/;
 
        die "\@end $ended without \@$ended at line $.\n" unless defined $endw;
        die "\@$endw ended by \@end $ended at line $.\n" unless $ended eq $endw;
 
        $endw = pop @endwstack;
 
-       if ($ended =~ /^(?:ifset|ifclear|ignore|menu)$/) {
+       if ($ended =~ /^(?:ifset|ifclear|ignore|menu|iftex)$/) {
            $skipping = pop @skstack;
            next;
-       } elsif ($ended =~ /^(?:example|smallexample)$/) {
+       } elsif ($ended =~ /^(?:example|smallexample|display)$/) {
            $shift = "";
            $_ = "";    # need a paragraph break
-       } elsif ($ended =~ /^(?:itemize|enumerate|table)$/) {
+       } elsif ($ended =~ /^(?:itemize|enumerate|[fv]?table)$/) {
            $_ = "\n=back\n";
            $ic = pop @icstack;
        } else {
@@ -160,7 +178,7 @@ while(<STDIN>)
        next;
     };
 
-    /^\@(ignore|menu)\b/ and do {
+    /^\@(ignore|menu|iftex)\b/ and do {
        push @endwstack, $endw;
        push @skstack, $skipping;
        $endw = $1;
@@ -189,6 +207,12 @@ while(<STDIN>)
     s/\@\{/&lbrace;/g;
     s/\@\}/&rbrace;/g;
     s/\@\@/&at;/g;
+
+    # Inside a verbatim block, handle @var specially.
+    if ($shift ne "") {
+       s/\@var\{([^\}]*)\}/<$1>/g;
+    }
+
     # POD doesn't interpret E<> inside a verbatim block.
     if ($shift eq "") {
        s/</&lt;/g;
@@ -199,11 +223,22 @@ while(<STDIN>)
     }
 
     # Single line command handlers.
-    /^\@set\s+([a-zA-Z0-9_-]+)\s*(.*)$/ and $defs{$1} = $2, next;
-    /^\@clear\s+([a-zA-Z0-9_-]+)/ and delete $defs{$1}, next;
 
-    /^\@section\s+(.+)$/ and $_ = "\n=head2 $1\n";
-    /^\@subsection\s+(.+)$/ and $_ = "\n=head3 $1\n";
+    /^\@include\s+(.+)$/ and do {
+       push @instack, $inf;
+       $inf = gensym();
+
+       # Try cwd and $ibase.
+       open($inf, "<" . $1) 
+           or open($inf, "<" . $ibase . "/" . $1)
+               or die "cannot open $1 or $ibase/$1: $!\n";
+       next;
+    };
+
+    /^\@(?:section|unnumbered|unnumberedsec|center)\s+(.+)$/
+       and $_ = "\n=head2 $1\n";
+    /^\@subsection\s+(.+)$/
+       and $_ = "\n=head3 $1\n";
 
     # Block command handlers:
     /^\@itemize\s+(\@[a-z]+|\*|-)/ and do {
@@ -214,7 +249,7 @@ while(<STDIN>)
        $endw = "itemize";
     };
 
-    /^\@enumerate(?:\s+([A-Z0-9]+))?/ and do {
+    /^\@enumerate(?:\s+([a-zA-Z0-9]+))?/ and do {
        push @endwstack, $endw;
        push @icstack, $ic;
        if (defined $1) {
@@ -226,19 +261,19 @@ while(<STDIN>)
        $endw = "enumerate";
     };
 
-    /^\@table\s+(\@[a-z]+)/ and do {
+    /^\@([fv]?table)\s+(\@[a-z]+)/ and do {
        push @endwstack, $endw;
        push @icstack, $ic;
-       $ic = $1;
+       $endw = $1;
+       $ic = $2;
        $ic =~ s/\@(?:samp|strong|key|gcctabopt|env)/B/;
        $ic =~ s/\@(?:code|kbd)/C/;
        $ic =~ s/\@(?:dfn|var|emph|cite|i)/I/;
        $ic =~ s/\@(?:file)/F/;
        $_ = "\n=over 4\n";
-       $endw = "table";
     };
 
-    /^\@((?:small)?example)/ and do {
+    /^\@((?:small)?example|display)/ and do {
        push @endwstack, $endw;
        $endw = $1;
        $shift = "\t";
@@ -251,12 +286,17 @@ while(<STDIN>)
            $_ = "\n=item $ic\&LT;$1\&GT;\n";
        } else {
            $_ = "\n=item $ic\n";
-           $ic =~ y/A-Ya-y1-8/B-Zb-z2-9/;
+           $ic =~ y/A-Ya-y/B-Zb-z/;
+           $ic =~ s/(\d+)/$1 + 1/eg;
        }
     };
 
     $section .= $shift.$_."\n";
 }
+# End of current file.
+close($inf);
+$inf = pop @instack;
+}
 
 die "No filename or title\n" unless defined $fn && defined $tl;
 
@@ -284,13 +324,15 @@ sub postprocess
     local $_ = $_[0];
 
     # @value{foo} is replaced by whatever 'foo' is defined as.
-    if (/\@value\{([a-zA-Z0-9_-]+)\}/) {
-       if (! exists $defs{$1}) {
-           print STDERR "Option $1 not define\n";
+    while (m/(\@value\{([a-zA-Z0-9_-]+)\})/g) {
+       if (! exists $defs{$2}) {
+           print STDERR "Option $2 not defined\n";
+           s/\Q$1\E//;
+       } else {
+           $value = $defs{$2};
+           s/\Q$1\E/$value/;
        }
-
     }
-    s/\@value\{([a-zA-Z0-9_-]+)\}/$defs{$1}/g;
 
     # Formatting commands.
     # Temporary escape for @r.
@@ -303,9 +345,6 @@ sub postprocess
     s/\@w\{([^\}]*)\}/S<$1>/g;
     s/\@(?:dmn|math)\{([^\}]*)\}/$1/g;
 
-    # Handle @r inside bold.
-    1 while s/B<((?:[^<>]|I<[^<>]*>)*)R<([^>]*)>/B<$1>${2}B</g;
-
     # Cross references are thrown away, as are @noindent and @refill.
     # (@noindent is impossible in .pod, and @refill is unnecessary.)
     # @* is also impossible in .pod; we discard it and any newline that
@@ -327,9 +366,11 @@ sub postprocess
     s/\@uref\{([^\},]*),([^\},]*),([^\},]*)\}/$3/g;
 
     # Turn B<blah I<blah> blah> into B<blah> I<blah> B<blah> to
-    # match Texinfo semantics of @emph inside @samp.
+    # match Texinfo semantics of @emph inside @samp.  Also handle @r
+    # inside bold.
     s/&LT;/</g;
     s/&GT;/>/g;
+    1 while s/B<((?:[^<>]|I<[^<>]*>)*)R<([^>]*)>/B<$1>${2}B</g;
     1 while (s/B<([^<>]*)I<([^>]+)>/B<$1>I<$2>B</g);
     1 while (s/I<([^<>]*)B<([^>]+)>/I<$1>B<$2>I</g);
     s/[BI]<>//g;
@@ -372,4 +413,15 @@ sub add_footnote
     $sects{FOOTNOTES} .= $_[0];
     $sects{FOOTNOTES} .= "\n\n";
 }
-    
+
+# stolen from Symbol.pm
+{
+    my $genseq = 0;
+    sub gensym
+    {
+       my $name = "GEN" . $genseq++;
+       my $ref = \*{$name};
+       delete $::{$name};
+       return $ref;
+    }
+}