develooper Front page | perl.perl5.porters | Postings from July 2001

[PATCH: perl@11373] pod fixups for pod/perlhack.pod

Thread Next
From:
Peter Prymmer
Date:
July 19, 2001 15:03
Subject:
[PATCH: perl@11373] pod fixups for pod/perlhack.pod
Message ID:
Pine.OSF.4.10.10107191455021.118307-100000@aspara.forte.com

While running through `make install` tests earlier today I saw the
following messages:

  /ttt/p0/man/man1/perlguts.1
Unknown escape E<> at ../pod/pod2man line 48
Unknown escape E<> at ../pod/pod2man line 48
Unknown escape E<> at ../pod/pod2man line 48
Unknown escape E<> at ../pod/pod2man line 48
Unknown escape E<> at ../pod/pod2man line 48
Unknown escape E<> at ../pod/pod2man line 48
Unknown escape E<> at ../pod/pod2man line 48
  /ttt/p0/man/man1/perlhack.1

So it would appear that I have an E<> problem at line 48
in my pod2man program - right?  No actually it is complaining
about several things in perlhack.pod but not reporting the line number.
FWIW line 48 in my extracted pod2man looks like so:

    45  my @files;
    46  do {
    47      @files = splice (@ARGV, 0, 2);
*** 48      $parser->parse_from_file (@files);
    49  } while (@ARGV);

It turns out that the problem is with several unrecognized E<>'s used
in perlhack.pod.  I run podchecker -warnings -warnings -warnings and
spotted a couple other troublesome nits:

*** WARNING: 2 unescaped <> in paragraph at line 1374 in file pod/perlhack.pod.orig
*** ERROR: garbled entity E<statistical time-sampling> at line 1740 in file pod/perlhack.pod.orig
*** ERROR: garbled entity E<basic-block counting> at line 1740 in file pod/perlhack.pod.orig
*** ERROR: garbled entity E<basic blocks> at line 1754 in file pod/perlhack.pod.orig
*** WARNING: Unknown entity E<instrumenting> at line 1758 in file pod/perlhack.pod.orig
*** ERROR: garbled entity E<enter basic block #nnnn> at line 1758 in file pod/perlhack.pod.orig
*** ERROR: garbled entity E<basic block profiling> at line 1814 in file pod/perlhack.pod.orig
*** ERROR: garbled entity E<basic-block counting> at line 1852 in file pod/perlhack.pod.orig
*** WARNING: multiple occurence of link target 'It's easier' at line - in file pod/perlhack.pod.orig

(it seems that podchecker is better at keeping track of input data file
line numbers than is pod2man???)

and then came up with this fix:

--- perl_11373/pod/perlhack.pod.orig	Thu Jul 19 14:17:28 2001
+++ perl_11373/pod/perlhack.pod	Thu Jul 19 14:51:32 2001
@@ -354,7 +354,7 @@
 
 =over 4
 
-=item It's easier
+=item It's easier to rsync the source tree
 
 Since you don't have to apply the patches yourself, you are sure all
 files in the source tree are in the right state.
@@ -382,7 +382,7 @@
 
 =over 4
 
-=item It's easier
+=item It's easier to rsync the patches
 
 If you have more than one machine that you want to keep in track with
 bleadperl, it's easier to rsync the patches only once and then apply
@@ -1371,7 +1371,7 @@
             }
         }
 
-< finish this later >
+# finish this later #
 
 =head2 Patching
 
@@ -1737,7 +1737,7 @@
 Depending on your platform there are various of profiling Perl.
 
 There are two commonly used techniques of profiling executables:
-E<statistical time-sampling> and E<basic-block counting>.
+C<statistical time-sampling> and C<basic-block counting>.
 
 The first method takes periodically samples of the CPU program
 counter, and since the program counter can be correlated with the code
@@ -1751,11 +1751,11 @@
 good idea for profiling), the second problem is usually kept in guard
 by the profiling tools themselves.
 
-The second method divides up the generated code into E<basic blocks>.
+The second method divides up the generated code into C<basic blocks>.
 Basic blocks are sections of code that are entered only in the
 beginning and exited only at the end.  For example, a conditional jump
 starts a basic block.  Basic block profiling usually works by
-E<instrumenting> the code by adding E<enter basic block #nnnn>
+C<instrumenting> the code by adding C<enter basic block #nnnn>
 book-keeping code to the generated code.  During the execution of the
 code the basic block counters are then updated appropriately.  The
 caveat is that the added extra code can skew the results: again, the
@@ -1811,7 +1811,7 @@
 
 =head2 GCC gcov Profiling
 
-Starting from GCC 3.0 E<basic block profiling> is officially available
+Starting from GCC 3.0 C<basic block profiling> is officially available
 for the GNU CC.
 
 You can build a profiled version of perl called F<perl.gcov> by
@@ -1849,7 +1849,7 @@
 
 Pixie is a profiling tool available on IRIX and Tru64 (aka Digital
 UNIX aka DEC OSF/1) platforms.  Pixie does its profiling using
-E<basic-block counting>.
+C<basic-block counting>.
 
 You can build a profiled version of perl called F<perl.pixie> by
 invoking the make target "perl.pixie" (what is required is that Perl
End of Patch.

Peter Prymmer



Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About