Porting/perldelta_template.pod

   1 =encoding utf8
   2
   3 =head1 NAME
   4
   5 [ this is a template for a new perldelta file. Any text flagged as
   6 XXX needs to be processed before release. ]
   7
   8 perldelta - what is new for perl v5.XXX.XXX
   9
  10 =head1 DESCRIPTION
  11
  12 This document describes differences between the 5.XXX.XXX release and
  13 the 5.XXX.XXX release.
  14
  15 If you are upgrading from an earlier release such as 5.XXX.XXX, first read
  16 L<perl5XXXdelta>, which describes differences between 5.XXX.XXX and
  17 5.XXX.XXX.
  18
  19 =head1 Notice
  20
  21 XXX Any important notices here
  22
  23 =head1 Incompatible Changes
  24
  25 XXX For a release on a stable branch, this section aspires to be:
  26
  27     There are no changes intentionally incompatible with 5.XXX.XXX. If any
  28     exist, they are bugs and reports are welcome.
  29
  30
  31 =head1 Core Enhancements
  32
  33 XXX New core language features go here. Summarise user-visible core language
  34 enhancements. Particularly prominent performance optimisations could go
  35 here, but most should go in the L</Performance Enhancements> section.
  36
  37 =head1 New Platforms
  38
  39 XXX List any platforms that this version of perl compiles on, that previous
  40 versions did not. These will either be enabled by new files in the F<hints/>
  41 directories, or new subdirectories and F<README> files at the top level of the
  42 source tree.
  43
  44 =head1 Modules and Pragmata
  45
  46 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
  47 go here.  If Module::CoreList is updated, generate an initial draft of the
  48 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
  49 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
  50 below.  A paragraph summary for important changes should then be added by hand.
  51 In an ideal world, dual-life modules would have a F<Changes> file that could be
  52 cribbed.
  53
  54 =head2 New Modules and Pragmata
  55
  56 =head2 Pragmata Changes
  57
  58 =head2 Updated Modules
  59
  60 =head2 Removed Modules and Pragmata
  61
  62 =head1 Utility Changes
  63
  64 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
  65 here. Most of these are built within the directories F<utils> and F<x2p>.
  66
  67 =over 4
  68
  69 =item F<XXX>
  70
  71 XXX
  72
  73 =back
  74
  75 =head1 New Documentation
  76
  77 XXX Changes which create B<new> files in F<pod/> go here.
  78
  79 =over 4
  80
  81 =item L<XXX>
  82
  83 XXX
  84
  85 =back
  86
  87 =head1 Changes to Existing Documentation
  88
  89 XXX Changes which significantly change existing files in F<pod/> go here.
  90 Any changes to F<pod/perldiag.pod> should go in L</New or Changed Diagnostics>.
  91
  92
  93 =head1 Performance Enhancements
  94
  95 XXX Changes which enhance performance without changing behaviour go here. There
  96 may well be none in a stable release.
  97
  98 =over 4
  99
 100 =item *
 101
 102 XXX
 103
 104 =back
 105
 106 =head1 Installation and Configuration Improvements
 107
 108 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
 109 go here.
 110
 111 =head2 Configuration improvements
 112
 113 XXX
 114
 115 =head2 Compilation improvements
 116
 117 XXX
 118
 119 =head2 Platform Specific Changes
 120
 121 =over 4
 122
 123 =item XXX-some-platform
 124
 125 XXX
 126
 127 =back
 128
 129 =head1 Selected Bug Fixes
 130
 131 XXX Important bug fixes in the core language are summarised here.
 132 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
 133 L</Modules and Pragmata>.
 134
 135 =over 4
 136
 137 =item *
 138
 139 XXX
 140
 141 =back
 142
 143 =head1 New or Changed Diagnostics
 144
 145 XXX New or changed warnings emitted by the core's C<C> code go here.
 146
 147 =over 4
 148
 149 =item C<XXX>
 150
 151 XXX
 152
 153 =back
 154
 155 =head1 Changed Internals
 156
 157 XXX Changes which affect the interface available to C<XS> code go here.
 158
 159 =over 4
 160
 161 =item *
 162
 163 XXX
 164
 165 =back
 166
 167 =head1 New Tests
 168
 169 XXX Changes which create B<new> files in F<t/> go here. Changes to
 170 existing files in F<t/> aren't worth summarising, although the bugs that
 171 they represent may be.
 172
 173 =over 4
 174
 175 =item F<XXX>
 176
 177 XXX
 178
 179 =back
 180
 181 =head1 Known Problems
 182
 183 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
 184 tests that had to be C<TODO>ed for the release would be noted here, unless
 185 they were specific to a particular platform (see below).
 186
 187 This is a list of some significant unfixed bugs, which are regressions
 188 from either 5.XXX.XXX or 5.XXX.XXX.
 189
 190 =over 4
 191
 192 =item *
 193
 194 XXX
 195
 196 =back
 197
 198 =head1 Deprecations
 199
 200 XXX Add any new known deprecations here.
 201
 202 The following items are now deprecated.
 203
 204 =over 4
 205
 206 =item *
 207
 208 XXX
 209
 210 =back
 211
 212 =head1 Platform Specific Notes
 213
 214 XXX Any changes specific to a particular platform. VMS and Win32 are the usual
 215 stars here. It's probably best to group changes under the same section layout
 216 as the main perldelta
 217
 218 =head1 Obituary
 219
 220 XXX If any significant core contributor has died, we've added a short obituary
 221 here.
 222
 223 =head1 Acknowledgements
 224
 225 XXX The list of people to thank goes here.
 226
 227
 228 =head1 Reporting Bugs
 229
 230 If you find what you think is a bug, you might check the articles
 231 recently posted to the comp.lang.perl.misc newsgroup and the perl
 232 bug database at http://rt.perl.org/perlbug/ .  There may also be
 233 information at http://www.perl.org/ , the Perl Home Page.
 234
 235 If you believe you have an unreported bug, please run the B<perlbug>
 236 program included with your release.  Be sure to trim your bug down
 237 to a tiny but sufficient test case.  Your bug report, along with the
 238 output of C<perl -V>, will be sent off to perlbug@perl.org to be
 239 analysed by the Perl porting team.
 240
 241 If the bug you are reporting has security implications, which make it
 242 inappropriate to send to a publicly archived mailing list, then please send
 243 it to perl5-security-report@perl.org. This points to a closed subscription
 244 unarchived mailing list, which includes all the core committers, who be able
 245 to help assess the impact of issues, figure out a resolution, and help
 246 co-ordinate the release of patches to mitigate or fix the problem across all
 247 platforms on which Perl is supported. Please only use this address for
 248 security issues in the Perl core, not for modules independently
 249 distributed on CPAN.
 250
 251 =head1 SEE ALSO
 252
 253 The F<Changes> file for an explanation of how to view exhaustive details
 254 on what changed.
 255
 256 The F<INSTALL> file for how to build Perl.
 257
 258 The F<README> file for general stuff.
 259
 260 The F<Artistic> and F<Copying> files for copyright information.
 261
 262 =cut