This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
podcheck.t: clarify its pod
authorKarl Williamson <public@khwilliamson.com>
Thu, 22 Sep 2011 15:19:02 +0000 (09:19 -0600)
committerKarl Williamson <public@khwilliamson.com>
Thu, 22 Sep 2011 15:24:13 +0000 (09:24 -0600)
t/porting/podcheck.t

index 85e4492..817814e 100644 (file)
@@ -115,11 +115,13 @@ A number of issues raised by podcheck.t and by the base Pod::Checker are not
 really problems, but merely potential problems, that is, false positives.
 After inspecting them and
 deciding that they aren't real problems, it is possible to shut up this program
-about them, unlike base Pod::Checker.  To do this, call podcheck.t with the
-C<--regen> option to regenerate the database.  This tells it that all existing
+about them, unlike base Pod::Checker.  For a valid link to an outside module
+or man page, call podcheck.t with the C<--add_link> option to add it to the
+the database of known links; for other causes, call podcheck.t with the C<--regen>
+option to regenerate the entire database.  This tells it that all existing
 issues are to not be mentioned again.
 
-This isn't fool-proof.  The database merely keeps track of the number of these
+C<--regen> isn't fool-proof.  The database merely keeps track of the number of these
 potential problems of each type for each pod.  If a new problem of a given
 type is introduced into the pod, podcheck.t will spit out all of them.  You
 then have to figure out which is the new one, and should it be changed or not.
@@ -137,7 +139,8 @@ the number of those problems for that pod to a negative number.  This will
 cause the corresponding error to always be suppressed no matter how many there
 actually are.
 
-There is currently no check that modules listed as valid in the data base
+Another problem is that there is currently no check that modules listed as
+valid in the data base
 actually are.  Thus any errors introduced there will remain there.
 
 =head2 Specially handled pods
@@ -149,7 +152,7 @@ actually are.  Thus any errors introduced there will remain there.
 This pod is generated by pasting bits from other pods.  Errors in those bits
 will show up as errors here, as well as for those other pods.  Therefore
 errors here are suppressed, and the pod is checked only to verify that nodes
-within it that are externally linked to actually exist.
+within it actually exist that are externally linked to.
 
 =item perldelta