This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add a utility to help test makedef.pl
[perl5.git] / Porting / perldelta_template.pod
index 7f9749a..59098fe 100644 (file)
@@ -40,8 +40,8 @@ L</Selected Bug Fixes> section.
 
 XXX For a release on a stable branch, this section aspires to be:
 
-    There are no changes intentionally incompatible with 5.XXX.XXX. If any
-    exist, they are bugs and reports are welcome.
+    There are no changes intentionally incompatible with 5.XXX.XXX
+    If any exist, they are bugs and reports are welcome.
 
 [ List each incompatible change as a =head2 entry ]
 
@@ -96,8 +96,7 @@ XXX
 
 =item *
 
-    [Verbatim block to avoid creating a bogus link]
-    L<XXX> has been upgraded from version 0.69 to version 0.70.
+L<XXX> has been upgraded from version 0.69 to version 0.70.
 
 =back
 
@@ -149,17 +148,35 @@ diagnostic messages, see L<perldiag>.
 XXX New or changed warnings emitted by the core's C<C> code go here. Also
 include any changes in L<perldiag> that reconcile it to the C<C> code.
 
-[ Within each section, list entries as a =item entry ]
+[ Within each section, list entries as a =item entry that links to perldiag,
+  e.g.
+
+  =item *
+
+  L<Invalid version object|perldiag/"Invalid version object">
+]
 
 =head2 New Diagnostics
 
 XXX Newly added diagnostic messages go here
 
+=head3 New Errors
+
 =over 4
 
 =item *
 
-XXX
+XXX L<message|perldiag/"message">
+
+=back
+
+=head3 New Warnings
+
+=over 4
+
+=item *
+
+XXX L<message|perldiag/"message">
 
 =back
 
@@ -171,7 +188,7 @@ XXX Changes (i.e. rewording) of diagnostic messages go here
 
 =item *
 
-XXX
+XXX Describe change here
 
 =back
 
@@ -284,7 +301,7 @@ XXX Changes which affect the interface available to C<XS> code go here.
 Other significant internal changes for future core maintainers should
 be noted as well.
 
-[ List each test improvement as a =item entry ]
+[ List each change as a =item entry ]
 
 =over 4
 
@@ -336,7 +353,9 @@ here.
 
 =head1 Acknowledgements
 
-XXX The list of people to thank goes here.
+XXX Generate this with:
+
+  perl Porting/acknowledgements.pl v5.15.1..HEAD
 
 =head1 Reporting Bugs
 
@@ -354,7 +373,8 @@ analysed by the Perl porting team.
 If the bug you are reporting has security implications, which make it
 inappropriate to send to a publicly archived mailing list, then please send
 it to perl5-security-report@perl.org. This points to a closed subscription
-unarchived mailing list, which includes all the core committers, who be able
+unarchived mailing list, which includes
+all the core committers, who will be able
 to help assess the impact of issues, figure out a resolution, and help
 co-ordinate the release of patches to mitigate or fix the problem across all
 platforms on which Perl is supported. Please only use this address for