This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Mention the clang thread safety analysis.
[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.23.6
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.5 release and the 5.23.6
13 release.
14
15 If you are upgrading from an earlier release such as 5.23.4, first read
16 L<perl5235delta>, which describes differences between 5.23.4 and 5.23.5.
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 =head2 Some regular expression patterns that had runtime errors now
41 don't compile at all
42
43 This should have been in the perldelta for 5.23.4, but was omitted.
44
45 Almost all Unicode properties using the C<\p{}> and C<\P{}> regular
46 expression pattern constructs are now checked for validity at pattern
47 compilation time, and invalid ones will cause the program to not
48 compile.  In earlier releases, this check was often deferred until run
49 time.  Whenever an error check is moved from run- to compile time,
50 erroneous code is caught 100% of the time, whereas before it would only
51 get caught if and when the offending portion actually gets executed,
52 which for unreachable code might be never.
53
54 =head1 Deprecations
55
56 XXX Any deprecated features, syntax, modules etc. should be listed here.
57
58 =head2 Module removals
59
60 XXX Remove this section if inapplicable.
61
62 The following modules will be removed from the core distribution in a
63 future release, and will at that time need to be installed from CPAN.
64 Distributions on CPAN which require these modules will need to list them as
65 prerequisites.
66
67 The core versions of these modules will now issue C<"deprecated">-category
68 warnings to alert you to this fact.  To silence these deprecation warnings,
69 install the modules in question from CPAN.
70
71 Note that these are (with rare exceptions) fine modules that you are encouraged
72 to continue to use.  Their disinclusion from core primarily hinges on their
73 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
74 not usually on concerns over their design.
75
76 =over
77
78 =item XXX
79
80 XXX Note that deprecated modules should be listed here even if they are listed
81 as an updated module in the L</Modules and Pragmata> section.
82
83 =back
84
85 [ List each other deprecation as a =head2 entry ]
86
87 =head2 Using code points above the platform's C<IV_MAX> is now
88 deprecated
89
90 Unicode defines code points in the range C<0..0x10FFFF>.  Some standards
91 at one time defined them up to 2**31 - 1, but Perl has allowed them to
92 be as high as anything that will fit in a word on the platform being
93 used.  However, use of those above the platform's C<IV_MAX> is broken in
94 some constructs, notably C<tr///>, regular expression patterns involving
95 quantifiers, and in some arithmetic and comparison operations, such as
96 being the upper limit of a loop.  Now the use of such code points raises
97 a deprecation warning, unless that warning category is turned off.
98 C<IV_MAX> is typically 2**31 -1 on 32-bit platforms, and 2**63-1 on
99 64-bit ones.
100
101 =head1 Performance Enhancements
102
103 XXX Changes which enhance performance without changing behaviour go here.
104 There may well be none in a stable release.
105
106 [ List each enhancement as a =item entry ]
107
108 =over 4
109
110 =item *
111
112 XXX
113
114 =back
115
116 =head1 Modules and Pragmata
117
118 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
119 go here.  If Module::CoreList is updated, generate an initial draft of the
120 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
121 for important changes should then be added by hand.  In an ideal world,
122 dual-life modules would have a F<Changes> file that could be cribbed.
123
124 [ Within each section, list entries as a =item entry ]
125
126 =head2 New Modules and Pragmata
127
128 =over 4
129
130 =item *
131
132 XXX
133
134 =back
135
136 =head2 Updated Modules and Pragmata
137
138 =over 4
139
140 =item *
141
142 L<DynaLoader> has been upgraded from version 1.36 to 1.37.
143
144 Fixed an else nesting issue in dynamic loading support for OS/390 (and
145 similar systems) that was introduced in 1.36.
146
147 =item *
148
149 L<utf8> has been upgraded from 1.17 to 1.18.
150
151 Partly reverted a micro-optimization to F<lib/utf_heavy.pl> that
152 caused self-recursion when it was loaded with C<${^ENCODING}> set.
153 [perl #126593]
154
155 =back
156
157 =head2 Removed Modules and Pragmata
158
159 =over 4
160
161 =item *
162
163 XXX
164
165 =back
166
167 =head1 Documentation
168
169 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
170 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
171
172 =head2 New Documentation
173
174 XXX Changes which create B<new> files in F<pod/> go here.
175
176 =head3 L<XXX>
177
178 XXX Description of the purpose of the new file here
179
180 =head2 Changes to Existing Documentation
181
182 XXX Changes which significantly change existing files in F<pod/> go here.
183 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
184 section.
185
186 =head3 L<XXX>
187
188 =over 4
189
190 =item *
191
192 XXX Description of the change here
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 L<message|perldiag/"Invalid number '%s' for -C option.">
217
218 (F) You supplied a number to the -C option that either has extra leading
219 zeroes or overflows perl's unsigned integer representation.
220
221
222 =back
223
224 =head3 New Warnings
225
226 =over 4
227
228 =item *
229
230 XXX L<message|perldiag/"message">
231
232 =back
233
234 =head2 Changes to Existing Diagnostics
235
236 XXX Changes (i.e. rewording) of diagnostic messages go here
237
238 =over 4
239
240 =item *
241
242 XXX Describe change here
243
244 =back
245
246 =head1 Utility Changes
247
248 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
249 Most of these are built within the directory F<utils>.
250
251 [ List utility changes as a =head2 entry for each utility and =item
252 entries for each change
253 Use L<XXX> with program names to get proper documentation linking. ]
254
255 =head2 L<XXX>
256
257 =over 4
258
259 =item *
260
261 XXX
262
263 =back
264
265 =head1 Configuration and Compilation
266
267 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
268 go here.  Any other changes to the Perl build process should be listed here.
269 However, any platform-specific changes should be listed in the
270 L</Platform Support> section, instead.
271
272 [ List changes as a =item entry ].
273
274 =over 4
275
276 =item *
277
278 F<make_ext.pl> is no longer inappropriately silent.  This was caused
279 by an operator precedence error introduced in 5.23.4.
280
281 =back
282
283 =head1 Testing
284
285 XXX Any significant changes to the testing of a freshly built perl should be
286 listed here.  Changes which create B<new> files in F<t/> go here as do any
287 large changes to the testing harness (e.g. when parallel testing was added).
288 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
289 that they represent may be covered elsewhere.
290
291 [ List each test improvement as a =item entry ]
292
293 =over 4
294
295 =item *
296
297 XXX
298
299 =back
300
301 =head1 Platform Support
302
303 XXX Any changes to platform support should be listed in the sections below.
304
305 [ Within the sections, list each platform as a =item entry with specific
306 changes as paragraphs below it. ]
307
308 =head2 New Platforms
309
310 XXX List any platforms that this version of perl compiles on, that previous
311 versions did not.  These will either be enabled by new files in the F<hints/>
312 directories, or new subdirectories and F<README> files at the top level of the
313 source tree.
314
315 =over 4
316
317 =item XXX-some-platform
318
319 XXX
320
321 =back
322
323 =head2 Discontinued Platforms
324
325 XXX List any platforms that this version of perl no longer compiles on.
326
327 =over 4
328
329 =item XXX-some-platform
330
331 XXX
332
333 =back
334
335 =head2 Platform-Specific Notes
336
337 XXX List any changes for specific platforms.  This could include configuration
338 and compilation changes or changes in portability/compatibility.  However,
339 changes within modules for platforms should generally be listed in the
340 L</Modules and Pragmata> section.
341
342 =over 4
343
344 =item EBCDIC platforms, such as z/OS
345
346 UTF-EBCDIC is like UTF-8, but for EBCDIC platforms.  It now has been
347 extended so that it can represent code points up to 2 ** 64 - 1 on
348 platforms with 64-bit words.  This brings it into parity with UTF-8.
349 This enhancement requires an incompatible change to the representation
350 of code points in the range 2 ** 30 to 2 ** 31 -1 (the latter was the
351 previous maximum representable code point).  This means that a file that
352 contains one of these code points, written out with previous versions of
353 perl cannot be read in, without conversion, by a perl containing this
354 change.  We do not believe any such files are in existence, but if you
355 do have one, submit a ticket at L<mailto:perlbug@perl.org>, and we will
356 write a conversion script for you.
357
358 =back
359
360 =head1 Internal Changes
361
362 XXX Changes which affect the interface available to C<XS> code go here.  Other
363 significant internal changes for future core maintainers should be noted as
364 well.
365
366 [ List each change as a =item entry ]
367
368 =over 4
369
370 =item *
371
372 Perl core code and the threads extension have been annotated so that
373 if Perl is configured to use threads, during compile-time clang (3.6
374 or later) will warn about suspicious uses of mutexes.
375 See L<http://clang.llvm.org/docs/ThreadSafetyAnalysis.html> for more
376 information.
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 C</...\G/> no longer crashes on utf8 strings. When C<\G> is a fixed number
392 of characters from the start of the regex, perl needs to count back that
393 many characters from the current C<pos()> position and start matching from
394 there. However, it was counting back bytes rather than characters, which
395 could lead to panics on utf8 strings.
396
397 =item *
398
399 In some cases operators that return integers would return negative
400 integers as large positive integers.  [perl #126635]
401
402 =item *
403
404 The pipe() operator would assert for DEBUGGING builds instead of
405 producing the correct error message.  The condition asserted on is
406 detected and reported on correctly without the assertions, so the
407 assertions were removed.  [perl #126480]
408
409 =item *
410
411 In some cases, failing to parse a here-doc would attempt to use freed
412 memory.  This was caused by a pointer not being restored correctly.
413 [perl #126443]
414
415 =back
416
417 =head1 Known Problems
418
419 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
420 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
421 platform specific bugs also go here.
422
423 [ List each fix as a =item entry ]
424
425 =over 4
426
427 =item *
428
429 XXX
430
431 =back
432
433 =head1 Errata From Previous Releases
434
435 =over 4
436
437 =item *
438
439 XXX Add anything here that we forgot to add, or were mistaken about, in
440 the perldelta of a previous release.
441
442 =back
443
444 =head1 Obituary
445
446 XXX If any significant core contributor has died, we've added a short obituary
447 here.
448
449 =head1 Acknowledgements
450
451 XXX Generate this with:
452
453   perl Porting/acknowledgements.pl v5.23.5..HEAD
454
455 =head1 Reporting Bugs
456
457 If you find what you think is a bug, you might check the articles recently
458 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
459 L<https://rt.perl.org/> .  There may also be information at
460 L<http://www.perl.org/> , the Perl Home Page.
461
462 If you believe you have an unreported bug, please run the L<perlbug> program
463 included with your release.  Be sure to trim your bug down to a tiny but
464 sufficient test case.  Your bug report, along with the output of C<perl -V>,
465 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
466
467 If the bug you are reporting has security implications, which make it
468 inappropriate to send to a publicly archived mailing list, then please send it
469 to perl5-security-report@perl.org.  This points to a closed subscription
470 unarchived mailing list, which includes all the core committers, who will be
471 able to help assess the impact of issues, figure out a resolution, and help
472 co-ordinate the release of patches to mitigate or fix the problem across all
473 platforms on which Perl is supported.  Please only use this address for
474 security issues in the Perl core, not for modules independently distributed on
475 CPAN.
476
477 =head1 SEE ALSO
478
479 The F<Changes> file for an explanation of how to view exhaustive details on
480 what changed.
481
482 The F<INSTALL> file for how to build Perl.
483
484 The F<README> file for general stuff.
485
486 The F<Artistic> and F<Copying> files for copyright information.
487
488 =cut