This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
ba7bb5db620d69a5ccb9ee26c443e219a3eaf0fe
[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.29.5
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.29.4 release and the 5.29.5
13 release.
14
15 If you are upgrading from an earlier release such as 5.29.3, first read
16 L<perl5294delta>, which describes differences between 5.29.3 and 5.29.4.
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 =head2 C<-Drv> now means something on C<-DDEBUGGING> builds
31
32 Now, adding the verbose flag (C<-Dv>) to the C<-Dr> flag turns on all
33 possible regular expression debugging.
34
35 =head1 Security
36
37 XXX Any security-related notices go here.  In particular, any security
38 vulnerabilities closed should be noted here rather than in the
39 L</Selected Bug Fixes> section.
40
41 [ List each security issue as a =head2 entry ]
42
43 =head1 Incompatible Changes
44
45 XXX For a release on a stable branch, this section aspires to be:
46
47     There are no changes intentionally incompatible with 5.XXX.XXX
48     If any exist, they are bugs, and we request that you submit a
49     report.  See L</Reporting Bugs> below.
50
51 [ List each incompatible change as a =head2 entry ]
52
53 =head1 Deprecations
54
55 XXX Any deprecated features, syntax, modules etc. should be listed here.
56
57 =head2 Module removals
58
59 XXX Remove this section if not applicable.
60
61 The following modules will be removed from the core distribution in a
62 future release, and will at that time need to be installed from CPAN.
63 Distributions on CPAN which require these modules will need to list them as
64 prerequisites.
65
66 The core versions of these modules will now issue C<"deprecated">-category
67 warnings to alert you to this fact.  To silence these deprecation warnings,
68 install the modules in question from CPAN.
69
70 Note that these are (with rare exceptions) fine modules that you are encouraged
71 to continue to use.  Their disinclusion from core primarily hinges on their
72 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
73 not usually on concerns over their design.
74
75 =over
76
77 =item XXX
78
79 XXX Note that deprecated modules should be listed here even if they are listed
80 as an updated module in the L</Modules and Pragmata> section.
81
82 =back
83
84 [ List each other deprecation as a =head2 entry ]
85
86 =head1 Performance Enhancements
87
88 XXX Changes which enhance performance without changing behaviour go here.
89 There may well be none in a stable release.
90
91 [ List each enhancement as an =item entry ]
92
93 =over 4
94
95 =item *
96
97 Regular expression pattern matching of things like C<qr/[^I<a>]/> is
98 significantly sped up, where I<a> is any ASCII character.  Which classes
99 will get this speed up is complicated and depends on the underlying bit
100 patterns of those characters, so differs between ASCII and EBCDIC
101 platforms, but all case pairs, like C<qr/[Gg]/> are included, as is
102 C<[^01]>.
103
104 =back
105
106 =head1 Modules and Pragmata
107
108 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
109 go here.  If Module::CoreList is updated, generate an initial draft of the
110 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
111 for important changes should then be added by hand.  In an ideal world,
112 dual-life modules would have a F<Changes> file that could be cribbed.
113
114 The list of new and updated modules is modified automatically as part of
115 preparing a Perl release, so the only reason to manually add entries here is if
116 you're summarising the important changes in the module update. (Also, if the
117 manually-added details don't match the automatically-generated ones, the
118 release manager will have to investigate the situation carefully.)
119
120 [ Within each section, list entries as an =item entry ]
121
122 =head2 New Modules and Pragmata
123
124 =over 4
125
126 =item *
127
128 XXX Remove this section if not applicable.
129
130 =back
131
132 =head2 Updated Modules and Pragmata
133
134 =over 4
135
136 =item *
137
138 L<XXX> has been upgraded from version A.xx to B.yy.
139
140 If there was something important to note about this change, include that here.
141
142 =back
143
144 =head2 Removed Modules and Pragmata
145
146 =over 4
147
148 =item *
149
150 XXX
151
152 =back
153
154 =head1 Documentation
155
156 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
157 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
158
159 =head2 New Documentation
160
161 XXX Changes which create B<new> files in F<pod/> go here.
162
163 =head3 L<XXX>
164
165 XXX Description of the purpose of the new file here
166
167 =head2 Changes to Existing Documentation
168
169 We have attempted to update the documentation to reflect the changes
170 listed in this document.  If you find any we have missed, send email
171 to L<perlbug@perl.org|mailto:perlbug@perl.org>.
172
173 XXX Changes which significantly change existing files in F<pod/> go here.
174 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
175 section.
176
177 Additionally, the following selected changes have been made:
178
179 =head3 L<XXX>
180
181 =over 4
182
183 =item *
184
185 XXX Description of the change here
186
187 =back
188
189 =head1 Diagnostics
190
191 The following additions or changes have been made to diagnostic output,
192 including warnings and fatal error messages.  For the complete list of
193 diagnostic messages, see L<perldiag>.
194
195 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
196 include any changes in L<perldiag> that reconcile it to the C<C> code.
197
198 =head2 New Diagnostics
199
200 XXX Newly added diagnostic messages go under here, separated into New Errors
201 and New Warnings
202
203 =head3 New Errors
204
205 =over 4
206
207 =item *
208
209 XXX L<message|perldiag/"message">
210
211 =back
212
213 =head3 New Warnings
214
215 =over 4
216
217 =item *
218
219 XXX L<message|perldiag/"message">
220
221 =back
222
223 =head2 Changes to Existing Diagnostics
224
225 XXX Changes (i.e. rewording) of diagnostic messages go here
226
227 =over 4
228
229 =item *
230
231 XXX Describe change here
232
233 =back
234
235 =head1 Utility Changes
236
237 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
238 Most of these are built within the directory F<utils>.
239
240 [ List utility changes as a =head2 entry for each utility and =item
241 entries for each change
242 Use L<XXX> with program names to get proper documentation linking. ]
243
244 =head2 L<XXX>
245
246 =over 4
247
248 =item *
249
250 XXX
251
252 =back
253
254 =head1 Configuration and Compilation
255
256 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
257 go here.  Any other changes to the Perl build process should be listed here.
258 However, any platform-specific changes should be listed in the
259 L</Platform Support> section, instead.
260
261 [ List changes as an =item entry ].
262
263 =over 4
264
265 =item *
266
267 XXX
268
269 =back
270
271 =head1 Testing
272
273 XXX Any significant changes to the testing of a freshly built perl should be
274 listed here.  Changes which create B<new> files in F<t/> go here as do any
275 large changes to the testing harness (e.g. when parallel testing was added).
276 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
277 that they represent may be covered elsewhere.
278
279 XXX If there were no significant test changes, say this:
280
281 Tests were added and changed to reflect the other additions and changes
282 in this release.
283
284 XXX If instead there were significant changes, say this:
285
286 Tests were added and changed to reflect the other additions and
287 changes in this release.  Furthermore, these significant changes were
288 made:
289
290 [ List each test improvement as an =item entry ]
291
292 =over 4
293
294 =item *
295
296 XXX
297
298 =back
299
300 =head1 Platform Support
301
302 XXX Any changes to platform support should be listed in the sections below.
303
304 [ Within the sections, list each platform as an =item entry with specific
305 changes as paragraphs below it. ]
306
307 =head2 New Platforms
308
309 XXX List any platforms that this version of perl compiles on, that previous
310 versions did not.  These will either be enabled by new files in the F<hints/>
311 directories, or new subdirectories and F<README> files at the top level of the
312 source tree.
313
314 =over 4
315
316 =item XXX-some-platform
317
318 XXX
319
320 =back
321
322 =head2 Discontinued Platforms
323
324 XXX List any platforms that this version of perl no longer compiles on.
325
326 =over 4
327
328 =item XXX-some-platform
329
330 XXX
331
332 =back
333
334 =head2 Platform-Specific Notes
335
336 XXX List any changes for specific platforms.  This could include configuration
337 and compilation changes or changes in portability/compatibility.  However,
338 changes within modules for platforms should generally be listed in the
339 L</Modules and Pragmata> section.
340
341 =over 4
342
343 =item Mac OS X
344
345 Perl's build and testing process on Mac OS X for C<-Duseshrplib>
346 builds is now compatible with Mac OS X System Integrity Protection
347 (SIP).
348
349 SIP prevents binaries in F</bin> (and a few other places) being passed
350 the C<DYLD_LIBRARY_PATH> environment variable.  For our purposes this
351 prevents C<DYLD_LIBRARY_PATH> from being passed to the shell, which
352 prevents that variable being passed to the testing or build process,
353 so running C<perl> couldn't find F<libperl.dylib>.
354
355 To workaround that, the initial build of the F<perl> executable
356 expects to find F<libperl.dylib> in the build directory, and the
357 library path is then adjusted during installation to point to the
358 installed library.
359
360 [perl #126706]
361
362 =back
363
364 =head1 Internal Changes
365
366 XXX Changes which affect the interface available to C<XS> code go here.  Other
367 significant internal changes for future core maintainers should be noted as
368 well.
369
370 [ List each change as an =item entry ]
371
372 =over 4
373
374 =item *
375
376 XXX
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 an =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 an =item entry ]
402
403 =over 4
404
405 =item *
406
407 XXX
408
409 =back
410
411 =head1 Errata From Previous Releases
412
413 =over 4
414
415 =item *
416
417 XXX Add anything here that we forgot to add, or were mistaken about, in
418 the perldelta of a previous release.
419
420 =back
421
422 =head1 Obituary
423
424 XXX If any significant core contributor or member of the CPAN community has
425 died, add a short obituary here.
426
427 =head1 Acknowledgements
428
429 XXX Generate this with:
430
431   perl Porting/acknowledgements.pl v5.29.4..HEAD
432
433 =head1 Reporting Bugs
434
435 If you find what you think is a bug, you might check the perl bug database
436 at L<https://rt.perl.org/> .  There may also be information at
437 L<http://www.perl.org/> , the Perl Home Page.
438
439 If you believe you have an unreported bug, please run the L<perlbug> program
440 included with your release.  Be sure to trim your bug down to a tiny but
441 sufficient test case.  Your bug report, along with the output of C<perl -V>,
442 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
443
444 If the bug you are reporting has security implications which make it
445 inappropriate to send to a publicly archived mailing list, then see
446 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
447 for details of how to report the issue.
448
449 =head1 Give Thanks
450
451 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
452 you can do so by running the C<perlthanks> program:
453
454     perlthanks
455
456 This will send an email to the Perl 5 Porters list with your show of thanks.
457
458 =head1 SEE ALSO
459
460 The F<Changes> file for an explanation of how to view exhaustive details on
461 what changed.
462
463 The F<INSTALL> file for how to build Perl.
464
465 The F<README> file for general stuff.
466
467 The F<Artistic> and F<Copying> files for copyright information.
468
469 =cut