This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
release managers guide: perldelta broken link handling
authorKarl Williamson <public@khwilliamson.com>
Wed, 27 Jul 2011 17:26:17 +0000 (11:26 -0600)
committerKarl Williamson <public@khwilliamson.com>
Wed, 27 Jul 2011 17:42:27 +0000 (11:42 -0600)
podcheck.t contains a list of placeholder links in perldelta that don't
point to a real target, and hence shouldn't generate messages.  This
list is to make the release manager's job easier.  But if new
placeholder links are created, it may be that they have to be added to
the list.

Porting/release_managers_guide.pod

index 935394b..3e72e18 100644 (file)
@@ -940,9 +940,28 @@ Run a clean build and test to make sure nothing obvious is broken.
 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
 from podchecker tests, to avoid false positives about placeholder text.
 However, once it's copied to F<pod/perldelta.pod> the contents can now
 In particular, F<Porting/perldelta_template.pod> is intentionally exempted
 from podchecker tests, to avoid false positives about placeholder text.
 However, once it's copied to F<pod/perldelta.pod> the contents can now
-cause test failures. Problems should resolved either by replacing placeholder
-text with correct text, or following the instructions output by
-F<t/porting/podcheck.t> on how to update its exceptions database.
+cause test failures. Problems should resolved by doing one of the
+following:
+
+=over
+
+=item 1
+
+Replace placeholder text with correct text.
+
+=item 2
+
+If the problem is from a broken placeholder link, you can add it to the
+array C<@perldelta_ignore_links> in F<t/porting/podcheck.t>.  Lines
+containing such links should be marked with C<XXX> so that they get
+cleaned up before the next release.
+
+=item 3
+
+Following the instructions output by F<t/porting/podcheck.t> on how to
+update its exceptions database.
+
+=back
 
 =head3 push commits
 
 
 =head3 push commits