From: Jesse Vincent Date: Tue, 6 Oct 2009 03:56:43 +0000 (-0400) Subject: more pod cleanups based on the new podcheck.t X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=64da3008c02a30fac03c1d2dc01e935495f210f8;p=p5sagit%2Fp5-mst-13.2.git more pod cleanups based on the new podcheck.t --- diff --git a/lib/version/Internals.pod b/lib/version/Internals.pod index 6228da1..42dde75 100644 --- a/lib/version/Internals.pod +++ b/lib/version/Internals.pod @@ -73,7 +73,7 @@ purposes of comparison with other version objects. For example: All of the preceding examples are true whether or not the input value is quoted. The important feature is that the input value contains only a -single decimal. See also L for how to handle +single decimal. See also L for how to handle IMPORTANT NOTE: As shown above, if your Decimal version contains more than 3 significant digits after the decimal place, it will be split on @@ -106,7 +106,7 @@ uniformity. See also L for an additional method of initializing version objects. Just like L, Dotted-Decimal Versions can be used as -L. +L. =head2 Decimal Alpha Versions @@ -270,8 +270,7 @@ With Perl >= 5.6.2, you can also use a line like this: use Example 1.2.3; and it will again work (i.e. give the error message as above), even with -releases of Perl which do not normally support v-strings (see L below). This has to do with that fact that C only checks +releases of Perl which do not normally support v-strings (see L below). This has to do with that fact that C only checks to see if the second term I and passes that to the replacement L. This is not true in Perl 5.005_04, however, so you are B to always use a Decimal version @@ -312,7 +311,7 @@ In other words, the version will be automatically parsed out of the string, and it will be quoted to preserve the meaning CVS normally carries for versions. The CVS $Revision$ increments differently from Decimal versions (i.e. 1.10 follows 1.9), so it must be handled as if -it were a L. +it were a Dotted-Decimal Version. A new version object can be created as a copy of an existing version object, either as a class method: @@ -372,7 +371,7 @@ L for details. For the subsequent examples, the following three objects will be used: $ver = version->new("1.2.3.4"); # see "Quoting" below - $alpha = version->new("1.2.3_4"); # see "Alpha versions" below + $alpha = version->new("1.2.3_4"); # see "new(1.002); # see "Decimal Versions" above =over 4 @@ -381,7 +380,7 @@ For the subsequent examples, the following three objects will be used: For any version object which is initialized with multiple decimal places (either quoted or if possible v-string), or initialized using -the L operator, the stringified representation is returned in +the L() operator, the stringified representation is returned in a normalized or reduced form (no extraneous zeros), and with a leading 'v': print $ver->normal; # prints as v1.2.3.4 @@ -445,22 +444,22 @@ when used as a class method. IMPORTANT NOTE: There is one exceptional cases shown in the above table where the "initializer" is not stringwise equivalent to the stringified -representation. If you use the C operator on a version without a +representation. If you use the C() operator on a version without a leading 'v' B with only a single decimal place, the stringified output -will have a leading 'v', to preserve the sense. See the L operator +will have a leading 'v', to preserve the sense. See the L() operator for more details. IMPORTANT NOTE 2: Attempting to bypass the normal stringification rules by -manually applying L and L will sometimes yield +manually applying L() and L() will sometimes yield surprising results: print version->new(version->new("v1.0")->numify)->normal; # v1.0.0 -The reason for this is that the L operator will turn "v1.0" +The reason for this is that the L() operator will turn "v1.0" into the equivalent string "1.000000". Forcing the outer version object -to L form will display the mathematically equivalent "v1.0.0". +to L() form will display the mathematically equivalent "v1.0.0". -As the example in L shows, you can always create a copy of an +As the example in L() shows, you can always create a copy of an existing version object with the same value by the very compact: $v2 = $v1->new($v1); @@ -517,7 +516,7 @@ has been initialized, you can simply test it directly: $vobj = version->new($something); if ( $vobj ) # true only if $something was non-blank -You can also test whether a version object is an L, for +You can also test whether a version object is an L, for example to prevent the use of some feature not present in the main release: @@ -531,10 +530,10 @@ release: Because of the nature of the Perl parsing and tokenizing routines, certain initialization values B be quoted in order to correctly -parse as the intended version, especially when using the L operator. +parse as the intended version, especially when using the L() operator. In all cases, a floating point number passed to version->new() will be identically converted whether or not the value itself is quoted. This is -not true for L, however, when trailing zeros would be stripped on +not true for L(), however, when trailing zeros would be stripped on an unquoted input, which would result in a very different version object. In addition, in order to be compatible with earlier Perl version styles, @@ -547,7 +546,7 @@ The complicating factor is that in bare numbers (i.e. unquoted), the underscore is a legal Decimal character and is automatically stripped by the Perl tokenizer before the version code is called. However, if a number containing one or more decimals and an underscore is quoted, i.e. -not bare, that is considered a L and the underscore is +not bare, that is considered an L and the underscore is significant. If you use a mathematic formula that resolves to a floating point number, diff --git a/make_patchnum.pl b/make_patchnum.pl index 55acb92..28148de 100644 --- a/make_patchnum.pl +++ b/make_patchnum.pl @@ -19,7 +19,7 @@ This program creates the files holding the information about locally applied patches to the source code. The created files are C and C. -=item C +=head2 C Contains status information from git in a form meant to be processed by the tied hash logic of Config.pm. It is actually optional, diff --git a/win32/bin/pl2bat.pl b/win32/bin/pl2bat.pl index 2b5bb4a..8fdfa3d 100644 --- a/win32/bin/pl2bat.pl +++ b/win32/bin/pl2bat.pl @@ -403,7 +403,7 @@ and must use A loop should be used to build up the argument list when not on Windows NT so more than 9 arguments can be processed. -See also L. +See also L. =head1 SEE ALSO diff --git a/win32/ce-helpers/comp.pl b/win32/ce-helpers/comp.pl index 3fab27c..f19350f 100644 --- a/win32/ce-helpers/comp.pl +++ b/win32/ce-helpers/comp.pl @@ -1,4 +1,4 @@ -=comments +=begin comment helper script to make life for PerlCE easier. @@ -77,8 +77,8 @@ else { } -=comments +=head1 AUTHOR - Author Vadim Konovalov. + Vadim Konovalov. =cut diff --git a/win32/sync_ext.pl b/win32/sync_ext.pl index c0ef13b..cb09285 100644 --- a/win32/sync_ext.pl +++ b/win32/sync_ext.pl @@ -1,4 +1,4 @@ -=comment +=begin comment Synchronize filename cases for extensions.