Front page | perl.perl5.porters |
Postings from March 2001
pod cleanups
Thread Next
From:
Michael Stevens
Date:
March 8, 2001 13:35
Subject:
pod cleanups
Message ID:
20010308213546.A26442@firedrake.org
The results of my attempts to cleanup some of the pod in
perl-current. I've done it on the assumption shutting up podchecker
is almost always a step forward - if this isn't so, some of
these changes may not be the Right Thing. Anyway. Comments. Whatever.
There are a lot of lint items left, but I'm still trying to work out
the right fixes for many of the rest.
diff -urN perl-current.orig/pod/perl5005delta.pod perl-current/pod/perl5005delta.pod
--- perl-current.orig/pod/perl5005delta.pod Sun Mar 4 12:47:43 2001
+++ perl-current/pod/perl5005delta.pod Thu Mar 8 21:26:07 2001
@@ -50,7 +50,7 @@
Some new keywords have been introduced. These are generally expected to
have very little impact on compatibility. See L<New C<INIT> keyword>,
-L<New C<lock> keyword>, and L<New C<qr//> operator>.
+L<New C<lock> keyword>, and L<New C<qrE<sol>E<sol>> operator>.
Certain barewords are now reserved. Use of these will provoke a warning
if you have asked for them with the C<-w> switch.
@@ -255,7 +255,7 @@
=item New operator for precompiled regular expressions
-See L<New C<qr//> operator>.
+See L<New C<qrE<sol>E<sol>> operator">.
=item Other improvements
@@ -492,7 +492,7 @@
If C<$/> is a reference to an integer, or a scalar that holds an integer,
<> will read in records instead of lines. For more info, see
-L<perlvar/$/>.
+L<perlvar/$E<sol>>.
=head1 Supported Platforms
@@ -609,6 +609,8 @@
You can now run tests for I<x> seconds instead of guessing the right
number of tests to run.
+Keeps better time.
+
=item Carp
Carp has a new function cluck(). cluck() warns, like carp(), but also adds
@@ -665,10 +667,6 @@
=item Cwd
Cwd::cwd is faster on most platforms.
-
-=item Benchmark
-
-Keeps better time.
=back
diff -urN perl-current.orig/pod/perldebtut.pod perl-current/pod/perldebtut.pod
--- perl-current.orig/pod/perldebtut.pod Sun Mar 4 12:47:43 2001
+++ perl-current/pod/perldebtut.pod Sun Mar 4 16:24:28 2001
@@ -21,10 +21,10 @@
debugger at all. To demonstrate, here's a simple script with a problem:
#!/usr/bin/perl
-
+
$var1 = 'Hello World'; # always wanted to do that :-)
$var2 = "$varl\n";
-
+
print $var2;
exit;
@@ -45,7 +45,7 @@
Now when you run it, perl complains about the 3 undeclared variables and we
get four error messages because one variable is referenced twice:
-
+
Global symbol "$var1" requires explicit package name at ./t1 line 4.
Global symbol "$var2" requires explicit package name at ./t1 line 5.
Global symbol "$varl" requires explicit package name at ./t1 line 5.
@@ -57,11 +57,11 @@
#!/usr/bin/perl
use strict;
-
+
my $var1 = 'Hello World';
my $varl = '';
my $var2 = "$varl\n";
-
+
print $var2;
exit;
@@ -97,7 +97,7 @@
Looks OK, after it's been through the syntax check (perl -c scriptname), we
run it and all we get is a blank line again! Hmmmm.
-
+
One common debugging approach here, would be to liberally sprinkle a few print
statements, to add a check just before we print out our data, and another just
after:
@@ -107,10 +107,10 @@
print "done: '$data{$key}'\n";
And try again:
-
+
> perl data
All OK
-
+
done: ''
After much staring at the same piece of code and not seeing the wood for the
@@ -137,7 +137,7 @@
DB<1> q
>
-
+
That's it, you're back on home turf again.
@@ -174,7 +174,7 @@
V [Pk [Vars]] List Variables in Package. Vars can be ~pattern or !pattern.
X [Vars] Same as "V current_package [Vars]".
For more help, type h cmd_letter, or run man perldebug for all docs.
-
+
More confusing options than you can shake a big stick at! It's not as bad as
it looks and it's very useful to know more about all of it, and fun too!
@@ -196,7 +196,7 @@
DM<3>X ~err
FileHandle(stderr) => fileno(2)
-
+
Remember we're in our tiny program with a problem, we should have a look at
where we are, and what our data looks like. First of all let's have a window
on our present position (the first line of code in this case), via the letter
@@ -216,7 +216,7 @@
At line number 4 is a helpful pointer, that tells you where you are now. To
see more code, type 'w' again:
-
+
DB<4> w
8 'welcome' => q(Hello World),
9 'zip' => q(welcome),
@@ -231,19 +231,19 @@
DB<4> l 5
5: my %data = (
-
+
In this case, there's not much to see, but of course normally there's pages of
stuff to wade through, and 'l' can be very useful. To reset your view to the
line we're about to execute, type a lone period '.':
DB<5> .
main::(./data_a:4): my $key = 'welcome';
-
+
The line shown is the one that is about to be executed B<next>, it hasn't
happened yet. So while we can print a variable with the letter 'B<p>', at
this point all we'd get is an empty (undefined) value back. What we need to
do is to step through the next executable statement with an 'B<s>':
-
+
DB<6> s
main::(./data_a:5): my %data = (
main::(./data_a:6): 'this' => qw(that),
@@ -264,21 +264,21 @@
DB<8> c 13
All OK
main::(./data_a:13): print "$data{$key}\n";
-
+
We've gone past our check (where 'All OK' was printed) and have stopped just
before the meat of our task. We could try to print out a couple of variables
to see what is happening:
DB<9> p $data{$key}
-
+
Not much in there, lets have a look at our hash:
-
+
DB<10> p %data
Hello Worldziptomandwelcomejerrywelcomethisthat
DB<11> p keys %data
Hello Worldtomwelcomejerrythis
-
+
Well, this isn't very easy to read, and using the helpful manual (B<h h>), the
'B<x>' command looks promising:
@@ -349,7 +349,7 @@
cont: {'col' => 'black', 'things' => [qw(this that etc)]}}, 'MY_class')
And let's have a look at it:
-
+
DB<2> x $obj
0 MY_class=HASH(0x828ad98)
'attr' => HASH(0x828ad68)
@@ -365,7 +365,7 @@
of code or regexes until the cows come home:
DB<3> @data = qw(this that the other atheism leather theory scythe)
-
+
DB<4> p 'saw -> '.($cnt += map { print "\t:\t$_\n" } grep(/the/, sort @data))
atheism
leather
@@ -384,7 +384,7 @@
1: $obj = bless({'unique_id'=>'123', 'attr'=>
{'col' => 'black', 'things' => [qw(this that etc)]}}, 'MY_class')
DB<5>
-
+
And if you want to repeat any previous command, use the exclamation: 'B<!>':
DB<5> !4
@@ -446,22 +446,22 @@
> temp -c0.72
33.30 f
-
+
> temp -f33.3
162.94 c
-
+
Not very consistent! We'll set a breakpoint in the code manually and run it
under the debugger to see what's going on. A breakpoint is a flag, to which
the debugger will run without interruption, when it reaches the breakpoint, it
will stop execution and offer a prompt for further interaction. In normal
use, these debugger commands are completely ignored, and they are safe - if a
little messy, to leave in production code.
-
+
my ($in, $out) = ($num, $num);
$DB::single=2; # insert at line 9!
if ($deg eq 'c')
...
-
+
> perl -d temp -f33.3
Default die handler restored.
@@ -478,7 +478,7 @@
main::(temp:10): if ($deg eq 'c') {
Followed by a window command to see where we are:
-
+
DB<1> w
7: my ($deg, $num) = ($1, $2);
8: my ($in, $out) = ($num, $num);
@@ -499,9 +499,9 @@
We can put another break point on any line beginning with a colon, we'll use
line 17 as that's just as we come out of the subroutine, and we'd like to
pause there later on:
-
+
DB<2> b 17
-
+
There's no feedback from this, but you can see what breakpoints are set by
using the list 'L' command:
@@ -550,13 +550,13 @@
DB<6> p (5 * $f - 32 / 9)
162.944444444444
-
+
DB<7> p 5 * $f - (32 / 9)
162.944444444444
-
+
DB<8> p (5 * $f) - 32 / 9
162.944444444444
-
+
DB<9> p 5 * ($f - 32) / 9
0.722222222222221
@@ -564,10 +564,10 @@
return out of the sub with an 'r':
DB<10> $c = 5 * ($f - 32) / 9
-
+
DB<11> r
scalar context return from main::f2c: 0.722222222222221
-
+
Looks good, let's just continue off the end of the script:
DB<12> c
@@ -585,11 +585,11 @@
Actions, watch variables, stack traces etc.: on the TODO list.
a
-
+
W
-
+
t
-
+
T
@@ -597,7 +597,7 @@
Ever wanted to know what a regex looked like? You'll need perl compiled with
the DEBUGGING flag for this one:
-
+
> perl -Dr -e '/^pe(a)*rl$/i'
Compiling REx `^pe(a)*rl$'
size 17 first at 2
@@ -674,7 +674,7 @@
B<ptkdb> perlTK based wrapper for the built-in debugger
B<ddd> data display debugger
-
+
B<PerlDevKit> and B<PerlBuilder> are NT specific
NB. (more info on these and others would be appreciated).
diff -urN perl-current.orig/pod/perldelta.pod perl-current/pod/perldelta.pod
--- perl-current.orig/pod/perldelta.pod Sun Mar 4 12:47:43 2001
+++ perl-current/pod/perldelta.pod Sun Mar 4 16:25:18 2001
@@ -891,7 +891,7 @@
# is still an experimental feature. It is here to stop people
# from deploying threads in production. ;-)
#
-
+
and another known thread-related warning is
pragma/overload......Unbalanced saves: 3 more saves than restores
diff -urN perl-current.orig/pod/perlfaq2.pod perl-current/pod/perlfaq2.pod
--- perl-current.orig/pod/perlfaq2.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlfaq2.pod Sun Mar 4 16:26:31 2001
@@ -79,7 +79,7 @@
% perl -V
You might also want to check out
-L<perlfaq8/"How do I keep my own module/library directory?">.
+L<perlfaq8/"How do I keep my own moduleE<sol>library directory?">.
=head2 I grabbed the sources and tried to compile but gdbm/dynamic loading/malloc/linking/... failed. How do I make it work?
diff -urN perl-current.orig/pod/perlfaq5.pod perl-current/pod/perlfaq5.pod
--- perl-current.orig/pod/perlfaq5.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlfaq5.pod Sun Mar 4 16:42:53 2001
@@ -31,7 +31,7 @@
If you expect characters to get to your device when you print them there,
you'll want to autoflush its handle.
Use select() and the C<$|> variable to control autoflushing
-(see L<perlvar/$|> and L<perlfunc/select>):
+(see L<perlvar/$E<verbar>> and L<perlfunc/select>):
$old_fh = select(OUTPUT_HANDLE);
$| = 1;
diff -urN perl-current.orig/pod/perlfaq7.pod perl-current/pod/perlfaq7.pod
--- perl-current.orig/pod/perlfaq7.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlfaq7.pod Sun Mar 4 16:43:03 2001
@@ -38,7 +38,7 @@
Note that <FILE> is I<neither> the type specifier for files
nor the name of the handle. It is the C<< <> >> operator applied
to the handle FILE. It reads one line (well, record--see
-L<perlvar/$/>) from the handle FILE in scalar context, or I<all> lines
+L<perlvar/$E<sol>>) from the handle FILE in scalar context, or I<all> lines
in list context. When performing open, close, or any other operation
besides C<< <> >> on files, or even when talking about the handle, do
I<not> use the brackets. These are correct: C<eof(FH)>, C<seek(FH, 0,
diff -urN perl-current.orig/pod/perlfaq8.pod perl-current/pod/perlfaq8.pod
--- perl-current.orig/pod/perlfaq8.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlfaq8.pod Sun Mar 4 17:07:12 2001
@@ -275,7 +275,7 @@
If you expect characters to get to your device when you print() them,
you'll want to autoflush that filehandle. You can use select()
-and the C<$|> variable to control autoflushing (see L<perlvar/$|>
+and the C<$|> variable to control autoflushing (see L<perlvar/$E<verbar>>
and L<perlfunc/select>, or L<perlfaq5>, ``How do I flush/unbuffer an
output filehandle? Why must I do this?''):
diff -urN perl-current.orig/pod/perlfunc.pod perl-current/pod/perlfunc.pod
--- perl-current.orig/pod/perlfunc.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlfunc.pod Sun Mar 4 17:07:31 2001
@@ -374,7 +374,7 @@
Accepts an incoming socket connect, just as the accept(2) system call
does. Returns the packed address if it succeeded, false otherwise.
-See the example in L<perlipc/"Sockets: Client/Server Communication">.
+See the example in L<perlipc/"Sockets: ClientE<sol>Server Communication">.
On systems that support a close-on-exec flag on files, the flag will
be set for the newly opened file descriptor, as determined by the
@@ -437,7 +437,7 @@
Binds a network address to a socket, just as the bind system call
does. Returns true if it succeeded, false otherwise. NAME should be a
packed address of the appropriate type for the socket. See the examples in
-L<perlipc/"Sockets: Client/Server Communication">.
+L<perlipc/"Sockets: ClientE<sol>Server Communication">.
=item binmode FILEHANDLE, DISCIPLINE
@@ -754,7 +754,7 @@
Attempts to connect to a remote socket, just as the connect system call
does. Returns true if it succeeded, false otherwise. NAME should be a
packed address of the appropriate type for the socket. See the examples in
-L<perlipc/"Sockets: Client/Server Communication">.
+L<perlipc/"Sockets: ClientE<sol>Server Communication">.
=item continue BLOCK
@@ -1028,7 +1028,7 @@
is supplied. Note that the "input line number" (also known as "chunk")
is subject to whatever notion of "line" happens to be currently in
effect, and is also available as the special variable C<$.>.
-See L<perlvar/"$/"> and L<perlvar/"$.">.
+See L<perlvar/"$E<sol>"> and L<perlvar/"$.">.
Hint: sometimes appending C<", stopped"> to your message
will cause it to make better sense when the string C<"at foo line 123"> is
@@ -1974,7 +1974,7 @@
standard Unix shell F</bin/csh> would do. This is the internal function
implementing the C<< <*.c> >> operator, but you can use it directly.
If EXPR is omitted, C<$_> is used. The C<< <*.c> >> operator is
-discussed in more detail in L<perlop/"I/O Operators">.
+discussed in more detail in L<perlop/"IE<sol>O Operators">.
Beginning with v5.6.0, this operator is implemented using the standard
C<File::Glob> extension. See L<File::Glob> for details.
@@ -2118,7 +2118,7 @@
There is no builtin C<import> function. It is just an ordinary
method (subroutine) defined (or inherited) by modules that wish to export
names to another module. The C<use> function calls the C<import> method
-for the package used. See also L</use()>, L<perlmod>, and L<Exporter>.
+for the package used. See also L</use>, L<perlmod>, and L<Exporter>.
=item index STR,SUBSTR,POSITION
@@ -2337,7 +2337,8 @@
=item listen SOCKET,QUEUESIZE
Does the same thing that the listen system call does. Returns true if
-it succeeded, false otherwise. See the example in L<perlipc/"Sockets: Client/Server Communication">.
+it succeeded, false otherwise. See the example in
+L<perlipc/"Sockets: ClientE<sol>Server Communication">.
=item local EXPR
@@ -2491,7 +2492,7 @@
%hash = map { ("\L$_", 1) } @array # this also works
%hash = map { lc($_), 1 } @array # as does this.
%hash = map +( lc($_), 1 ), @array # this is EXPR and works!
-
+
%hash = map ( lc($_), 1 ), @array # evaluates to (1, @array)
or to force an anon hash constructor use C<+{>
@@ -3529,7 +3530,7 @@
reached, whereupon the subsequent call returns undef. In list context,
reads until end-of-file is reached and returns a list of lines. Note that
the notion of "line" used here is however you may have defined it
-with C<$/> or C<$INPUT_RECORD_SEPARATOR>). See L<perlvar/"$/">.
+with C<$/> or C<$INPUT_RECORD_SEPARATOR>). See L<perlvar/"$E<sol>">.
When C<$/> is set to C<undef>, when readline() is in scalar
context (i.e. file slurp mode), and when an empty file is read, it
@@ -3537,7 +3538,7 @@
This is the internal function implementing the C<< <EXPR> >>
operator, but you can use it directly. The C<< <EXPR> >>
-operator is discussed in more detail in L<perlop/"I/O Operators">.
+operator is discussed in more detail in L<perlop/"IE<sol>O Operators">.
$line = <STDIN>;
$line = readline(*STDIN); # same thing
@@ -3560,7 +3561,7 @@
(however you've defined lines with C<$/> or C<$INPUT_RECORD_SEPARATOR>).
This is the internal function implementing the C<qx/EXPR/>
operator, but you can use it directly. The C<qx/EXPR/>
-operator is discussed in more detail in L<perlop/"I/O Operators">.
+operator is discussed in more detail in L<perlop/"IE<sol>O Operators">.
=item recv SOCKET,SCALAR,LENGTH,FLAGS
@@ -4143,7 +4144,7 @@
SOCKET. DOMAIN, TYPE, and PROTOCOL are specified the same as for
the system call of the same name. You should C<use Socket> first
to get the proper definitions imported. See the examples in
-L<perlipc/"Sockets: Client/Server Communication">.
+L<perlipc/"Sockets: ClientE<sol>Server Communication">.
On systems that support a close-on-exec flag on files, the flag will
be set for the newly opened file descriptor, as determined by the
diff -urN perl-current.orig/pod/perlhack.pod perl-current/pod/perlhack.pod
--- perl-current.orig/pod/perlhack.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlhack.pod Sun Mar 4 15:22:11 2001
@@ -1241,7 +1241,7 @@
=item break source.c:xxx
Tells the debugger that we'll want to pause execution when we reach
-either the named function (but see L</Function names>!) or the given
+either the named function (but see L<perlguts/Internal Functions>!) or the given
line in the named source file.
=item step
@@ -1299,7 +1299,7 @@
(gdb) break Perl_pp_add
Breakpoint 1 at 0x46249f: file pp_hot.c, line 309.
-Notice we use C<Perl_pp_add> and not C<pp_add> - see L<perlguts/Function Names>.
+Notice we use C<Perl_pp_add> and not C<pp_add> - see L<perlguts/Internal Functions>.
With the breakpoint in place, we can run our program:
(gdb) run -e '$b = "6XXXX"; $c = 2.3; $a = $b + $c'
diff -urN perl-current.orig/pod/perllexwarn.pod perl-current/pod/perllexwarn.pod
--- perl-current.orig/pod/perllexwarn.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perllexwarn.pod Sun Mar 4 16:46:54 2001
@@ -325,16 +325,16 @@
warning.
use warnings ;
-
+
time ;
-
+
{
use warnings FATAL => qw(void) ;
length "abc" ;
}
-
+
join "", 1,2,3 ;
-
+
print "done\n" ;
When run it produces this output
diff -urN perl-current.orig/pod/perllocale.pod perl-current/pod/perllocale.pod
--- perl-current.orig/pod/perllocale.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perllocale.pod Sun Mar 4 16:02:26 2001
@@ -381,7 +381,7 @@
localeconv() takes no arguments, and returns B<a reference to> a hash.
The keys of this hash are variable names for formatting, such as
C<decimal_point> and C<thousands_sep>. The values are the
-corresponding, er, values. See L<POSIX (3)/localeconv> for a longer
+corresponding, er, values. See L<POSIX/localeconv> for a longer
example listing the categories an implementation might be expected to
provide; some provide more and others fewer. You don't need an
explicit C<use locale>, because localeconv() always observes the
@@ -964,12 +964,12 @@
=head1 SEE ALSO
-L<POSIX (3)/isalnum>, L<POSIX (3)/isalpha>, L<POSIX (3)/isdigit>,
-L<POSIX (3)/isgraph>, L<POSIX (3)/islower>, L<POSIX (3)/isprint>,
-L<POSIX (3)/ispunct>, L<POSIX (3)/isspace>, L<POSIX (3)/isupper>,
-L<POSIX (3)/isxdigit>, L<POSIX (3)/localeconv>, L<POSIX (3)/setlocale>,
-L<POSIX (3)/strcoll>, L<POSIX (3)/strftime>, L<POSIX (3)/strtod>,
-L<POSIX (3)/strxfrm>.
+L<POSIX/isalnum>, L<POSIX/isalpha>, L<POSIX/isdigit>,
+L<POSIX/isgraph>, L<POSIX/islower>, L<POSIX/isprint>,
+L<POSIX/ispunct>, L<POSIX/isspace>, L<POSIX/isupper>,
+L<POSIX/isxdigit>, L<POSIX/localeconv>, L<POSIX/setlocale>,
+L<POSIX/strcoll>, L<POSIX/strftime>, L<POSIX/strtod>,
+L<POSIX/strxfrm>.
=head1 HISTORY
diff -urN perl-current.orig/pod/perllol.pod perl-current/pod/perllol.pod
--- perl-current.orig/pod/perllol.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perllol.pod Sun Mar 4 17:11:11 2001
@@ -4,7 +4,7 @@
=head1 DESCRIPTION
-=head1 Declaration and Access of Arrays of Arrays
+=head2 Declaration and Access of Arrays of Arrays
The simplest thing to build an array of arrays (sometimes imprecisely
called a list of lists). It's reasonably easy to understand, and
@@ -58,7 +58,7 @@
But you cannot do so for the very first one if it's a scalar containing
a reference, which means that $ref_to_AoA always needs it.
-=head1 Growing Your Own
+=head2 Growing Your Own
That's all well and good for declaration of a fixed data structure,
but what if you wanted to add new elements on the fly, or build
@@ -174,7 +174,7 @@
In fact, that wouldn't even compile. How come? Because the argument
to push() must be a real array, not just a reference to such.
-=head1 Access and Printing
+=head2 Access and Printing
Now it's time to print your data structure out. How
are you going to do that? Well, if you want only one
@@ -231,7 +231,7 @@
}
}
-=head1 Slices
+=head2 Slices
If you want to get at a slice (part of a row) in a multidimensional
array, you're going to have to do some fancy subscripting. That's
diff -urN perl-current.orig/pod/perlmod.pod perl-current/pod/perlmod.pod
--- perl-current.orig/pod/perlmod.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlmod.pod Sun Mar 4 16:30:24 2001
@@ -61,8 +61,8 @@
Variables beginning with underscore used to be forced into package
main, but we decided it was more useful for package writers to be able
to use leading underscore to indicate private variables and method names.
-$_ is still global though. See also L<perlvar/"Technical Note on the
-Syntax of Variable Names">.
+$_ is still global though. See also
+L<perlvar/"Technical Note on the Syntax of Variable Names">.
C<eval>ed strings are compiled in the package in which the eval() was
compiled. (Assignments to C<$SIG{}>, however, assume the signal
diff -urN perl-current.orig/pod/perlmodlib.pod perl-current/pod/perlmodlib.pod
--- perl-current.orig/pod/perlmodlib.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlmodlib.pod Sun Mar 4 17:13:04 2001
@@ -799,7 +799,7 @@
some of which require a C compiler to build. Major categories of
modules are:
-=over
+=over 4
=item *
@@ -890,7 +890,7 @@
Registered CPAN sites as of this writing include the following.
You should try to choose one close to you:
-=over
+=over 4
=item Africa
diff -urN perl-current.orig/pod/perlop.pod perl-current/pod/perlop.pod
--- perl-current.orig/pod/perlop.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlop.pod Sun Mar 4 17:13:53 2001
@@ -91,7 +91,7 @@
constructors C<[]> and C<{}>.
See also L<Quote and Quote-like Operators> toward the end of this section,
-as well as L<"I/O Operators">.
+as well as L<"IE<sol>O Operators">.
=head2 The Arrow Operator
@@ -803,7 +803,7 @@
and is useful when the value you are interpolating won't change over
the life of the script. However, mentioning C</o> constitutes a promise
that you won't change the variables in the pattern. If you change them,
-Perl won't even notice. See also L<"qr/STRING/imosx">.
+Perl won't even notice. See also L<"qrE<sol>STRINGE<sol>imosx">.
If the PATTERN evaluates to the empty string, the last
I<successfully> matched regular expression is used instead.
@@ -1090,7 +1090,7 @@
a glue language, and one of the things it glues together is commands.
Just understand what you're getting yourself into.
-See L<"I/O Operators"> for more discussion.
+See L<"IE<sol>O Operators"> for more discussion.
=item qw/STRING/
diff -urN perl-current.orig/pod/perlopentut.pod perl-current/pod/perlopentut.pod
--- perl-current.orig/pod/perlopentut.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlopentut.pod Sun Mar 4 17:14:16 2001
@@ -685,7 +685,7 @@
What else can you open? To open a connection using sockets, you won't use
one of Perl's two open functions. See
-L<perlipc/"Sockets: Client/Server Communication"> for that. Here's an
+L<perlipc/"Sockets: ClientE<sol>Server Communication"> for that. Here's an
example. Once you have it, you can use FH as a bidirectional filehandle.
use IO::Socket;
diff -urN perl-current.orig/pod/perlport.pod perl-current/pod/perlport.pod
--- perl-current.orig/pod/perlport.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlport.pod Sun Mar 4 13:40:36 2001
@@ -720,10 +720,11 @@
=item *
The U/WIN environment for Win32,
-<http://www.research.att.com/sw/tools/uwin/
+http://www.research.att.com/sw/tools/uwin/
-=item Build instructions for OS/2, L<perlos2>
+=item *
+Build instructions for OS/2, L<perlos2>
=back
diff -urN perl-current.orig/pod/perlre.pod perl-current/pod/perlre.pod
--- perl-current.orig/pod/perlre.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlre.pod Sun Mar 4 17:14:38 2001
@@ -566,7 +566,7 @@
expression involves run-time interpolation of variables, unless the
perilous C<use re 'eval'> pragma has been used (see L<re>), or the
variables contain results of C<qr//> operator (see
-L<perlop/"qr/STRING/imosx">).
+L<perlop/"qrE<sol>STRINGE<sol>imosx">).
This restriction is because of the wide-spread and remarkably convenient
custom of using run-time determined strings as patterns. For example:
diff -urN perl-current.orig/pod/perlrun.pod perl-current/pod/perlrun.pod
--- perl-current.orig/pod/perlrun.pod Sun Mar 4 12:47:44 2001
+++ perl-current/pod/perlrun.pod Sun Mar 4 16:50:33 2001
@@ -450,8 +450,7 @@
with the next one (if it exists).
For a discussion of issues surrounding file permissions and B<-i>,
-see L<perlfaq5/Why does Perl let me delete read-only files? Why
-does -i clobber protected files? Isn't this a bug in Perl?>.
+see L<perlfaq5/Why does Perl let me delete read-only files? Why does -i clobber protected files? Isn't this a bug in Perl?>.
You cannot use B<-i> to create directories or to strip extensions from
files.
diff -urN perl-current.orig/pod/perltoc.pod perl-current/pod/perltoc.pod
--- perl-current.orig/pod/perltoc.pod Sun Mar 4 12:47:45 2001
+++ perl-current/pod/perltoc.pod Sun Mar 4 14:51:54 2001
@@ -2303,8 +2303,8 @@
=item Step-by-step: Making the module
Start with F<h2xs>, Use L<strict|strict> and L<warnings|warnings>, Use
-L<Carp|Carp>, Use L<Exporter|Exporter> - wisely!, Use L<plain old
-documentation|perlpod>, Write tests, Write the README
+L<Carp|Carp>, Use L<Exporter|Exporter> - wisely!,
+Use L<plain old documentation|perlpod>, Write tests, Write the README
=item Step-by-step: Distributing your module
diff -urN perl-current.orig/pod/perltrap.pod perl-current/pod/perltrap.pod
--- perl-current.orig/pod/perltrap.pod Sun Mar 4 12:47:45 2001
+++ perl-current/pod/perltrap.pod Sun Mar 4 16:40:02 2001
@@ -696,7 +696,7 @@
# perl4 prints: 0
# perl5 prints:
-Also see L<"General Regular Expression Traps using s///, etc.">
+Also see L<"General Regular Expression Traps using sE<sol>E<sol>E<sol>, etc.">
for another example of this new feature...
=item * Bitwise string ops
diff -urN perl-current.orig/pod/perlxs.pod perl-current/pod/perlxs.pod
--- perl-current.orig/pod/perlxs.pod Sun Mar 4 12:47:45 2001
+++ perl-current/pod/perlxs.pod Sun Mar 4 16:17:20 2001
@@ -809,9 +809,9 @@
(here the optional C<IN> keyword is omitted).
The C<IN_OUT> parameters are identical with parameters introduced with
-L<The & Unary Operator> and put into the C<OUTPUT:> section (see L<The
-OUTPUT: Keyword>). The C<IN_OUTLIST> parameters are very similar, the
-only difference being that the value C function writes through the
+L<The & Unary Operator> and put into the C<OUTPUT:> section (see
+L<The OUTPUT: Keyword>). The C<IN_OUTLIST> parameters are very similar,
+the only difference being that the value C function writes through the
pointer would not modify the Perl parameter, but is put in the output
list.
diff -urN perl-current.orig/pod/perlxstut.pod perl-current/pod/perlxstut.pod
--- perl-current.orig/pod/perlxstut.pod Sun Mar 4 12:47:45 2001
+++ perl-current/pod/perlxstut.pod Sun Mar 4 13:48:26 2001
@@ -1094,15 +1094,15 @@
HV * rh;
STRLEN l;
char * fn = SvPV(*av_fetch((AV *)SvRV(paths), n, 0), l);
-
+
i = statfs(fn, &buf);
if (i != 0) {
av_push(results, newSVnv(errno));
continue;
}
-
+
rh = (HV *)sv_2mortal((SV *)newHV());
-
+
hv_store(rh, "f_bavail", 8, newSVnv(buf.f_bavail), 0);
hv_store(rh, "f_bfree", 7, newSVnv(buf.f_bfree), 0);
hv_store(rh, "f_blocks", 8, newSVnv(buf.f_blocks), 0);
@@ -1110,7 +1110,7 @@
hv_store(rh, "f_ffree", 7, newSVnv(buf.f_ffree), 0);
hv_store(rh, "f_files", 7, newSVnv(buf.f_files), 0);
hv_store(rh, "f_type", 6, newSVnv(buf.f_type), 0);
-
+
av_push(results, newRV((SV *)rh));
}
RETVAL = newRV((SV *)results);
Thread Next
-
pod cleanups
by Michael Stevens