Tidy up comments.
[p5sagit/p5-mst-13.2.git] / Porting / how_to_write_a_perldelta.pod
index 1d21b92..53265bd 100644 (file)
@@ -6,6 +6,12 @@ looks something close to the existing perldeltas". So if it's unclear how
 do to do something, see if it's been done before, and if the approach works
 there, steal it.
 
+=head2 Template
+
+Note there is a file F<Porting/perldelta_template> which contains a
+skeleton version of a perldelta.pod file, which should normally be copied
+in at the start of a new release.
+
 =head2 Style
 
 Pod is more a physical markup language, rather than a logical markup language.
@@ -49,7 +55,8 @@ C<Debian bug #379463>
 Be consistent.
 
 In a list, either make every item a note, or a full sentence. Either end
-every item with a full stop, or ensure that no item ends with one.
+every item with a full stop, or ensure that no item ends with one. I<regex>
+B<xor> I<regexp> - choose exactly one, and stick to it.
 
 =head2 Sections
 
@@ -173,6 +180,10 @@ Descriptions of platform agnostic bugs we know we can't fix go here. Any
 tests that had to be C<TODO>ed for the release would be noted here, unless
 they were specific to a particular platform (see below).
 
+=item Deprecations
+
+Add any new known deprecations here.
+
 =item Platform Specific Notes
 
 Any changes specific to a particular platform. VMS and Win32 are the usual