Stop system select from croaking on read-only COW ""

[perl5.git] / Porting / how_to_write_a_perldelta.pod

diff --git a/Porting/how_to_write_a_perldelta.pod b/Porting/how_to_write_a_perldelta.pod
index 851ed28..a7bfc4a 100644 (file)
--- a/Porting/how_to_write_a_perldelta.pod
+++ b/Porting/how_to_write_a_perldelta.pod
@@ -1,4 +1,8 @@
-=head1 How to write a perldelta
+=head1 NAME
+
+how_to_write_a_perldelta - How to write a perldelta
+
+=head2 Description

 
 This is intended as a guide for how to write a perldelta. There has never
 been a formal specification - the working rule is "fake up a document that
 
 This is intended as a guide for how to write a perldelta. There has never
 been a formal specification - the working rule is "fake up a document that


@@ -8,7 +12,7 @@ there, steal it.
 
 =head2 Template
 
 
 =head2 Template
 

-Note there is a file F<Porting/perldelta_template> which contains a
+Note there is a file F<Porting/perldelta_template.pod> which contains a

 skeleton version of a perldelta.pod file, which should normally be copied
 in at the start of a new release.
 
 skeleton version of a perldelta.pod file, which should normally be copied
 in at the start of a new release.
 


@@ -37,8 +41,13 @@ Be consistent in how bugs are referenced. One style is
 
 =item rt.perl.org
 
 
 =item rt.perl.org
 

-C<RT #43010> inline, but enclose in square brackets after a sentence.
-C<[RT #43010]>
+C<perl #43010> inline, but enclose in square brackets after a sentence.
+C<[perl #43010]>.  This mirrors how rt.perl.org subject lines appear.
+
+=item rt.cpan.org
+
+C<rt.cpan.org #43010> inline, but enclose in square brackets after a sentence.
+C<[rt.cpan.org #43010]>.  This mirrors how rt.cpan.org subject lines appear.

 
 =item ActiveState
 
 
 =item ActiveState
 


@@ -77,13 +86,13 @@ Follows this formula:
 
 For a release on a stable branch, follows this formula:
 
 
 For a release on a stable branch, follows this formula:
 

-    This document describes differences between the 5.10.3 release and
-    the 5.10.4 release.
+    This document describes differences between the 5.10.3 release
+    and the 5.10.4 release.

 
 For the start of a new stable branch, follows this formula:
 
 
 For the start of a new stable branch, follows this formula:
 

-    This document describes differences between the 5.12.0 release and
-    the 5.10.0 release.
+    This document describes differences between the 5.12.0 release
+    and the 5.10.0 release.

 
 Clearly this sets the scope of which changes are to be summarised in the rest
 of the document.
 
 Clearly this sets the scope of which changes are to be summarised in the rest
 of the document.


@@ -97,8 +106,8 @@ notice.
 
 For a release on a stable branch, this section aspires to be
 
 
 For a release on a stable branch, this section aspires to be
 

-    There are no changes intentionally incompatible with 5.10.3. If any exist,
-    they are bugs and reports are welcome.
+    There are no changes intentionally incompatible with 5.10.3.
+    If any exist, they are bugs and reports are welcome.

 
 =item Core Enhancements
 
 
 =item Core Enhancements
 


@@ -132,7 +141,7 @@ within F<ext/> and F<lib/> to a number of people.
 B<FIXME> - this could be automated better
 
 If Module::CoreList has been updated, then F<Porting/corelist-perldelta.pl>
 B<FIXME> - this could be automated better
 
 If Module::CoreList has been updated, then F<Porting/corelist-perldelta.pl>

-will automatically print out several sections if relevent that can be
+will automatically print out several sections if relevant that can be

 pasted into F<perldelta>:
 
     * New Modules and Pragmata
 pasted into F<perldelta>:
 
     * New Modules and Pragmata


@@ -147,7 +156,7 @@ Each section will have stub entries following a template like this:
     Upgraded from version 0.01 to 0.02
 
 It does not include modules listed in F<Porting/Maintainers.pl> under
     Upgraded from version 0.01 to 0.02
 
 It does not include modules listed in F<Porting/Maintainers.pl> under

-C<_PERLLIB>, but it's a start.  Where relevent, a summary of changes can be
+C<_PERLLIB>, but it's a start.  Where relevant, a summary of changes can be

 added by hand.
 
 A more adventurous enhancement would be to automate grabbing
 added by hand.
 
 A more adventurous enhancement would be to automate grabbing


@@ -298,15 +307,9 @@ here.
 
 =item Acknowledgements
 
 
 =item Acknowledgements
 

-The list of people to thank goes here.
-
-You can find the list of committers and authors by:
-
-  % git log --pretty='format:%an' v5.11.1..HEAD | sort | uniq
-
-And how many files where changed by:
+Generate this with:

 
 

-  % git diff --stat=200,200 v5.11.1..HEAD
+  perl Porting/acknowledgements.pl v5.15.0..HEAD

 
 =item Reporting Bugs
 
 
 =item Reporting Bugs