This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
8d5972d27b7c0039f199b42856d1dd4311b45cd8
[perl5.git] / pod / perldelta.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 [ this is a template for a new perldelta file.  Any text flagged as XXX needs
6 to be processed before release. ]
7
8 perldelta - what is new for perl v5.19.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.19.1 release and the 5.19.2
13 release.
14
15 If you are upgrading from an earlier release such as 5.19.0, first read
16 L<perl5191delta>, which describes differences between 5.19.0 and 5.19.1.
17
18 =head1 Notice
19
20 XXX Any important notices here
21
22 =head1 Core Enhancements
23
24 XXX New core language features go here.  Summarize user-visible core language
25 enhancements.  Particularly prominent performance optimisations could go
26 here, but most should go in the L</Performance Enhancements> section.
27
28 [ List each enhancement as a =head2 entry ]
29
30 =head1 Security
31
32 XXX Any security-related notices go here.  In particular, any security
33 vulnerabilities closed should be noted here rather than in the
34 L</Selected Bug Fixes> section.
35
36 [ List each security issue as a =head2 entry ]
37
38 =head1 Incompatible Changes
39
40 XXX For a release on a stable branch, this section aspires to be:
41
42     There are no changes intentionally incompatible with 5.XXX.XXX
43     If any exist, they are bugs, and we request that you submit a
44     report.  See L</Reporting Bugs> below.
45
46 [ List each incompatible change as a =head2 entry ]
47
48 =head1 Deprecations
49
50 XXX Any deprecated features, syntax, modules etc. should be listed here.
51
52 =head2 Module removals
53
54 XXX Remove this section if inapplicable.
55
56 The following modules will be removed from the core distribution in a
57 future release, and will at that time need to be installed from CPAN.
58 Distributions on CPAN which require these modules will need to list them as
59 prerequisites.
60
61 The core versions of these modules will now issue C<"deprecated">-category
62 warnings to alert you to this fact.  To silence these deprecation warnings,
63 install the modules in question from CPAN.
64
65 Note that these are (with rare exceptions) fine modules that you are encouraged
66 to continue to use.  Their disinclusion from core primarily hinges on their
67 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
68 not usually on concerns over their design.
69
70 =over
71
72 XXX Note that deprecated modules should be listed here even if they are listed
73 as an updated module in the L</Modules and Pragmata> section.
74
75 =back
76
77 [ List each other deprecation as a =head2 entry ]
78
79 =head1 Performance Enhancements
80
81 XXX Changes which enhance performance without changing behaviour go here.
82 There may well be none in a stable release.
83
84 [ List each enhancement as a =item entry ]
85
86 =over 4
87
88 =item *
89
90 XXX
91
92 =back
93
94 =head1 Modules and Pragmata
95
96 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
97 go here.  If Module::CoreList is updated, generate an initial draft of the
98 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
99 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
100 below.  A paragraph summary for important changes should then be added by hand.
101 In an ideal world, dual-life modules would have a F<Changes> file that could be
102 cribbed.
103
104 [ Within each section, list entries as a =item entry ]
105
106 =head2 New Modules and Pragmata
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head2 Updated Modules and Pragmata
117
118 =over 4
119
120 =item *
121
122 L<ExtUtils::Embed> has been upgraded from version 1.30 to 1.31
123
124 The generated C<C> code now incorporates bug fixes present in
125 F<miniperlmain.c>, and has whitespace changes. It now uses
126 C<#include "..."> for header files instead of C<< #include <...> >>.
127 This should not make any difference, unless programs embedding C<libperl>
128 happen to have local and incompatible files named F<EXTERN.h>, F<XSUB.h> or
129 F<perl.h>, as these will now be picked up instead of the installed Perl
130 headers.
131
132 =item *
133
134 L<ExtUtils::Miniperl> has been upgraded and given a version of 1.
135 Previously it did not have a version number.
136
137 C<writemain()> now takes an optional first argument. A reference to a scalar
138 is treated as a filename to be opened and written to. Any other reference is
139 used as the filehandle to write to. Otherwise the existing default remains,
140 to write to C<STDOUT>.
141
142 C<writemain()> has been refactored to use functions from L<ExtUtils::Embed>,
143 reducing code size and duplication. The internal function C<canon()> has been
144 deleted.
145
146 =item *
147
148 L<POSIX> has been upgraded from version 1.33 to 1.34.
149
150 C<POSIX::AUTOLOAD> will no longer infinitely recurse if the shared
151 object fails to load.
152
153 =back
154
155 =head2 Removed Modules and Pragmata
156
157 =over 4
158
159 =item *
160
161 XXX
162
163 =back
164
165 =head1 Documentation
166
167 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
168 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
169
170 =head2 New Documentation
171
172 XXX Changes which create B<new> files in F<pod/> go here.
173
174 =head3 L<XXX>
175
176 XXX Description of the purpose of the new file here
177
178 =head2 Changes to Existing Documentation
179
180 XXX Changes which significantly change existing files in F<pod/> go here.
181 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
182 section.
183
184 =head3 L<perlexperiment>
185
186 =over 4
187
188 =item *
189
190 Code in regular expressions, regular expression backtracking verbs,
191 and lvalue subroutines are no longer listed as experimental.  (This
192 also affects L<perlre> and L<perlsub>.)
193
194 =back
195
196 =head1 Diagnostics
197
198 The following additions or changes have been made to diagnostic output,
199 including warnings and fatal error messages.  For the complete list of
200 diagnostic messages, see L<perldiag>.
201
202 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
203 include any changes in L<perldiag> that reconcile it to the C<C> code.
204
205 =head2 New Diagnostics
206
207 XXX Newly added diagnostic messages go under here, separated into New Errors
208 and New Warnings
209
210 =head3 New Errors
211
212 =over 4
213
214 =item *
215
216 XXX L<message|perldiag/"message">
217
218 =back
219
220 =head3 New Warnings
221
222 =over 4
223
224 =item *
225
226 XXX L<message|perldiag/"message">
227
228 =back
229
230 =head2 Changes to Existing Diagnostics
231
232 XXX Changes (i.e. rewording) of diagnostic messages go here
233
234 =over 4
235
236 =item *
237
238 XXX Describe change here
239
240 =back
241
242 =head1 Utility Changes
243
244 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
245 Most of these are built within the directories F<utils> and F<x2p>.
246
247 [ List utility changes as a =head3 entry for each utility and =item
248 entries for each change
249 Use L<XXX> with program names to get proper documentation linking. ]
250
251 =head3 L<XXX>
252
253 =over 4
254
255 =item *
256
257 XXX
258
259 =back
260
261 =head1 Configuration and Compilation
262
263 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
264 go here.  Any other changes to the Perl build process should be listed here.
265 However, any platform-specific changes should be listed in the
266 L</Platform Support> section, instead.
267
268 [ List changes as a =item entry ].
269
270 =over 4
271
272 =item *
273
274 XXX
275
276 =back
277
278 =head1 Testing
279
280 XXX Any significant changes to the testing of a freshly built perl should be
281 listed here.  Changes which create B<new> files in F<t/> go here as do any
282 large changes to the testing harness (e.g. when parallel testing was added).
283 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
284 that they represent may be covered elsewhere.
285
286 [ List each test improvement as a =item entry ]
287
288 =over 4
289
290 =item *
291
292 XXX
293
294 =back
295
296 =head1 Platform Support
297
298 XXX Any changes to platform support should be listed in the sections below.
299
300 [ Within the sections, list each platform as a =item entry with specific
301 changes as paragraphs below it. ]
302
303 =head2 New Platforms
304
305 XXX List any platforms that this version of perl compiles on, that previous
306 versions did not.  These will either be enabled by new files in the F<hints/>
307 directories, or new subdirectories and F<README> files at the top level of the
308 source tree.
309
310 =over 4
311
312 =item XXX-some-platform
313
314 XXX
315
316 =back
317
318 =head2 Discontinued Platforms
319
320 XXX List any platforms that this version of perl no longer compiles on.
321
322 =over 4
323
324 =item XXX-some-platform
325
326 XXX
327
328 =back
329
330 =head2 Platform-Specific Notes
331
332 XXX List any changes for specific platforms.  This could include configuration
333 and compilation changes or changes in portability/compatibility.  However,
334 changes within modules for platforms should generally be listed in the
335 L</Modules and Pragmata> section.
336
337 =over 4
338
339 =item MidnightBSD
340
341 C<objformat> was removed from version 0.4-RELEASE of MidnightBSD and had been
342 deprecated on earlier versions.  This caused the build environment to be
343 erroneously configured for C<a.out> rather than C<elf>.  This has been now
344 been corrected.
345
346 =back
347
348 =head1 Internal Changes
349
350 XXX Changes which affect the interface available to C<XS> code go here.  Other
351 significant internal changes for future core maintainers should be noted as
352 well.
353
354 [ List each change as a =item entry ]
355
356 =over 4
357
358 =item *
359
360 The Makefile shortcut targets for many rarely (or never) used testing and
361 profiling targets have been removed, or merged into the only other Makefile
362 target that uses them.  Specifically, these targets are gone, along with
363 documentation that referenced them or explained how to use them:
364
365  check.third check.utf16 check.utf8 coretest minitest.prep
366  minitest.utf16 perl.config.dashg perl.config.dashpg
367  perl.config.gcov perl.gcov perl.gprof perl.gprof.config perl.pixie
368  perl.pixie.atom perl.pixie.config perl.pixie.irix perl.third
369  perl.third.config pureperl purecovperl quantperl test.deparse
370  test.taintwarn test.third test.torture test.utf16 test.utf8
371  test_notty.deparse test_notty.third test_prep.third torturetest
372  ucheck ucheck.third ucheck.utf16 ucheck.valgrind utest utest.third
373  utest.utf16 utest.valgrind
374
375 It's still possible to run the relevant commands by "hand" - no underlying
376 functionality has been removed.
377
378 =back
379
380 =head1 Selected Bug Fixes
381
382 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
383 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
384
385 [ List each fix as a =item entry ]
386
387 =over 4
388
389 =item *
390
391 XXX
392
393 =back
394
395 =head1 Known Problems
396
397 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
398 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
399 platform specific bugs also go here.
400
401 [ List each fix as a =item entry ]
402
403 =over 4
404
405 =item *
406
407 XXX
408
409 =back
410
411 =head1 Obituary
412
413 XXX If any significant core contributor has died, we've added a short obituary
414 here.
415
416 =head1 Acknowledgements
417
418 XXX Generate this with:
419
420   perl Porting/acknowledgements.pl v5.19.1..HEAD
421
422 =head1 Reporting Bugs
423
424 If you find what you think is a bug, you might check the articles recently
425 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
426 http://rt.perl.org/perlbug/ .  There may also be information at
427 http://www.perl.org/ , the Perl Home Page.
428
429 If you believe you have an unreported bug, please run the L<perlbug> program
430 included with your release.  Be sure to trim your bug down to a tiny but
431 sufficient test case.  Your bug report, along with the output of C<perl -V>,
432 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
433
434 If the bug you are reporting has security implications, which make it
435 inappropriate to send to a publicly archived mailing list, then please send it
436 to perl5-security-report@perl.org.  This points to a closed subscription
437 unarchived mailing list, which includes all the core committers, who will be
438 able to help assess the impact of issues, figure out a resolution, and help
439 co-ordinate the release of patches to mitigate or fix the problem across all
440 platforms on which Perl is supported.  Please only use this address for
441 security issues in the Perl core, not for modules independently distributed on
442 CPAN.
443
444 =head1 SEE ALSO
445
446 The F<Changes> file for an explanation of how to view exhaustive details on
447 what changed.
448
449 The F<INSTALL> file for how to build Perl.
450
451 The F<README> file for general stuff.
452
453 The F<Artistic> and F<Copying> files for copyright information.
454
455 =cut