From 11cd32314e021c5d20f69a6f0f607f979dd3e03a Mon Sep 17 00:00:00 2001 From: Karl Williamson Date: Sat, 22 Oct 2022 11:05:23 -0600 Subject: [PATCH] Add a step to the RMG about podcheck It's quick to skim the podcheck summary of errors, and some things, like broken links should really be fixed before the release. --- Porting/release_managers_guide.pod | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/Porting/release_managers_guide.pod b/Porting/release_managers_guide.pod index 50890b2c3580..10e60c98fd50 100644 --- a/Porting/release_managers_guide.pod +++ b/Porting/release_managers_guide.pod @@ -397,6 +397,21 @@ colon-delimited versions to use for comparison. For example: L +=head3 check pod errors + +F is a porting test that will fail if it finds new +problems in pods. However, it can be taught to ignore problems, and +sometimes people do so for problems that really should be fixed before +release. To see what it is ignoring, run + + perl t/porting/podcheck.t --counts + +Any problems listed as pedantic aren't worth your time investigating. +These have a C at the beginning of the text, or are for the too-long +verbatim lines. + +But other warnings should be. In particular, a broken link can well +mean that someone clicking on the pod in a web page will get a 404. =head3 update perldelta Get perldelta in a mostly finished state.