From: David Mitchell Date: Sun, 23 Aug 2009 15:17:46 +0000 (+0100) Subject: add Porting/perldelta_template, X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=57b3b745ca01e2d8a868d86e4412a3d5859b3850;p=p5sagit%2Fp5-mst-13.2.git add Porting/perldelta_template, a skeleton outline of a perldelta file --- diff --git a/MANIFEST b/MANIFEST index b70837d..f539080 100644 --- a/MANIFEST +++ b/MANIFEST @@ -3780,6 +3780,7 @@ Porting/makerel Release making utility Porting/make_snapshot.pl Make a tgz snapshot of our tree with a .patch file in it Porting/manicheck Check against MANIFEST Porting/manisort Sort the MANIFEST +Porting/perldelta_template Template for creating new perldelta.pod files Porting/podtidy Reformat pod using Pod::Tidy Porting/pumpkin.pod Guidelines and hints for Perl maintainers Porting/README.y2038 Perl notes for the 2038 fix diff --git a/Porting/how_to_write_a_perldelta.pod b/Porting/how_to_write_a_perldelta.pod index dd8dac1..53265bd 100644 --- a/Porting/how_to_write_a_perldelta.pod +++ b/Porting/how_to_write_a_perldelta.pod @@ -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 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. diff --git a/Porting/perldelta_template b/Porting/perldelta_template new file mode 100644 index 0000000..effa536 --- /dev/null +++ b/Porting/perldelta_template @@ -0,0 +1,280 @@ +=head1 NAME + +[ this is a template for a new perldelta file. Any text flagged as +XXX needs to be processed before release. ] + +perldelta - what is new for perl v5.XXX.XXX + +=head1 DESCRIPTION + +This document describes differences between the 5.XXX.XXX release and +the 5.XXX.XXX release. + +If you are upgrading from an earlier release such as 5.XXX.XXX, first read +the L, which describes differences between 5.XXX.XXX and +5.10.0 + +=head1 Notice + +XXX Any important notices here + +=head1 Incompatible Changes + +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. + + +=head1 Core Enhancements + +XXX New core language features go here. Summarise user-visible core language +enhancements. Particularly prominent performance optimisations could go +here, but most should go in the L section. + +=head1 New Platforms + +XXX List any platforms that this version of perl compiles on, that previous +versions did not. These will either be enabled by new files in the F +directories, or new subdirectories and F files at the top level of the +source tree. + +=head1 Modules and Pragmata + +XXX All changes to installed files in F and F go here, in a list +ordered by distribution name. Minimally it should be the module version, +but it's more useful to the end user to give a paragraph's summary of the +module's changes. In an ideal world, dual-life modules would have a +F file that could be cribbed. + +=head2 New Modules and Pragmata + +=over 4 + +=item C + +XXX + +=back + +=head2 Pragmata Changes + +=over 4 + +=item C + +XXX + +=back + +=head2 Updated Modules + +=over 4 + +=item C + +XXX + +=back + +=head1 Utility Changes + +XXX Changes to installed programs such as F and F go +here. Most of these are built within the directories F and F. + +=over 4 + +=item F + +XXX + +=back + +=head1 New Documentation + +XXX Changes which create B files in F go here. + +=over 4 + +=item L + +XXX + +=back + +=head1 Changes to Existing Documentation + +XXX Changes which significantly change existing files in F go here. +Any changes to F should go in L. + + +=head1 Performance Enhancements + +XXX Changes which enhance performance without changing behaviour go here. There +may well be none in a stable release. + +=over 4 + +=item * + +XXX + +=back + +=head1 Installation and Configuration Improvements + +XXX Changes to F, F, F, and analogous tools +go here. + +=head2 Configuration improvements + +XXX + +=head2 Compilation improvements + +XXX + +=head2 Platform Specific Changes + +=over 4 + +=item XXX-some-platform + +XXX + +=back + +=head1 Selected Bug Fixes + +XXX Important bug fixes in the core language are summarised here. +Bug fixes in files in F and F are best summarised in +L. + +=over 4 + +=item * + +XXX + +=back + +=head1 New or Changed Diagnostics + +XXX New or changed warnings emitted by the core's C code go here. + +=over 4 + +=item C + +XXX + +=back + +=head1 Changed Internals + +XXX Changes which affect the interface available to C code go here. + +=over 4 + +=item * + +XXX + +=back + +=head1 New Tests + +XXX Changes which create B files in F go here. Changes to +existing files in F aren't worth summarising, although the bugs that +they represent may be. + +=over 4 + +=item F + +XXX + +=back + +=head1 Known Problems + +XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any +tests that had to be Ced for the release would be noted here, unless +they were specific to a particular platform (see below). + +This is a list of some significant unfixed bugs, which are regressions +from either 5.XXX.XXX or 5.XXX.XXX. + +=over 4 + +=item * + +XXX + +=back + +=head1 Deprecations + +XXX Add any new known deprecations here. + +The following items are now deprecated. + +=over 4 + +=item * + +XXX + +=back + +=head1 Platform Specific Notes + +XXX Any changes specific to a particular platform. VMS and Win32 are the usual +stars here. It's probably best to group changes under the same section layout +as the main perldelta + +=item Obituary + +XXX If any significant core contributor has died, we've added a short obituary +here. + +=head1 Acknowledgements + +XXX The list of people to thank goes here. + + +=head1 Reporting Bugs + +If you find what you think is a bug, you might check the articles +recently posted to the comp.lang.perl.misc newsgroup and the perl +bug database at http://rt.perl.org/perlbug/ . There may also be +information at http://www.perl.org/ , the Perl Home Page. + +If you believe you have an unreported bug, please run the B +program included with your release. Be sure to trim your bug down +to a tiny but sufficient test case. Your bug report, along with the +output of C, will be sent off to perlbug@perl.org to be +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 +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 +security issues in the Perl core, not for modules independently +distributed on CPAN. + +=head1 SEE ALSO + +The F file for an explanation of how to view exhaustive details +on what changed. + +The F file for how to build Perl. + +The F file for general stuff. + +The F and F files for copyright information. + +=cut