summaryrefslogtreecommitdiff
path: root/Porting/release_managers_guide.pod
diff options
context:
space:
mode:
authorKarl Williamson <public@khwilliamson.com>2011-07-27 11:26:17 -0600
committerKarl Williamson <public@khwilliamson.com>2011-07-27 11:42:27 -0600
commitef4474b5b7af564ed5f0979a4019b7fb79bb0233 (patch)
treecdb55564ddb2a85e8ee3c7f35a70737f6d82bc25 /Porting/release_managers_guide.pod
parentbc20e6b8a4c898602b2a6d438e089d520615b45e (diff)
downloadperl-ef4474b5b7af564ed5f0979a4019b7fb79bb0233.tar.gz
release managers guide: perldelta broken link handling
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.
Diffstat (limited to 'Porting/release_managers_guide.pod')
-rw-r--r--Porting/release_managers_guide.pod25
1 files changed, 22 insertions, 3 deletions
diff --git a/Porting/release_managers_guide.pod b/Porting/release_managers_guide.pod
index 935394b1a6..3e72e183c4 100644
--- a/Porting/release_managers_guide.pod
+++ b/Porting/release_managers_guide.pod
@@ -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
-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