fix variable name in case of unknown NAN
[perl.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.1
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.23.0 release and the 5.23.1
13 release.
14
15 If you are upgrading from an earlier release such as 5.22.0, first read
16 L<perl5230delta>, which describes differences between 5.22.0 and 5.23.0.
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 Integer shift (C<< << >> and C<< >> >>) now explicitly defined
31
32 Negative shifts are reverse shifts: left shift becomes right shift,
33 and right shift becomes left shift.
34
35 Shifting by the number of bits in a native integer (or more) is zero,
36 except when the "overshift" is right shifting a negative value under
37 C<use integer>, in which case the result is -1 (arithmetic shift).
38
39 Until now negative shifting and overshifting have been undefined
40 because they have relied on whatever the C implementation happens
41 to do.  For example, for the "overshift" a common behavior C is
42 "modulo shift":
43
44   1 >> 64 == 1 >> (64 % 64) == 1 >> 0 == 1  # Common C behavior.
45
46   # And the same for <<, while Perl now produces 0 for both.
47
48 Now these behaviors are well-defined under Perl, regardless of what
49 the underlying C implementation does.  Note, however, that you cannot
50 escape the native integer width.  If you need more bits on the left shift,
51 you could use the C<bigint> pragma.
52
53 =head2 Postfix dereferencing is no longer experimental
54
55 Using the C<postderef> and C<postderef_qq> features no longer emits a warning.
56 Existing code that disables that warning category will continue to work. The
57 C<5.24> feature bundle now includes those features.
58
59 =head1 Security
60
61 XXX Any security-related notices go here.  In particular, any security
62 vulnerabilities closed should be noted here rather than in the
63 L</Selected Bug Fixes> section.
64
65 [ List each security issue as a =head2 entry ]
66
67 =head1 Incompatible Changes
68
69 XXX For a release on a stable branch, this section aspires to be:
70
71     There are no changes intentionally incompatible with 5.XXX.XXX
72     If any exist, they are bugs, and we request that you submit a
73     report.  See L</Reporting Bugs> below.
74
75 [ List each incompatible change as a =head2 entry ]
76
77 =head1 Deprecations
78
79 XXX Any deprecated features, syntax, modules etc. should be listed here.
80
81 =head2 Module removals
82
83 XXX Remove this section if inapplicable.
84
85 The following modules will be removed from the core distribution in a
86 future release, and will at that time need to be installed from CPAN.
87 Distributions on CPAN which require these modules will need to list them as
88 prerequisites.
89
90 The core versions of these modules will now issue C<"deprecated">-category
91 warnings to alert you to this fact.  To silence these deprecation warnings,
92 install the modules in question from CPAN.
93
94 Note that these are (with rare exceptions) fine modules that you are encouraged
95 to continue to use.  Their disinclusion from core primarily hinges on their
96 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
97 not usually on concerns over their design.
98
99 =over
100
101 =item XXX
102
103 XXX Note that deprecated modules should be listed here even if they are listed
104 as an updated module in the L</Modules and Pragmata> section.
105
106 =back
107
108 [ List each other deprecation as a =head2 entry ]
109
110 =head1 Performance Enhancements
111
112 XXX Changes which enhance performance without changing behaviour go here.
113 There may well be none in a stable release.
114
115 [ List each enhancement as a =item entry ]
116
117 =over 4
118
119 =item *
120
121 XXX
122
123 =back
124
125 =head1 Modules and Pragmata
126
127 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
128 go here.  If Module::CoreList is updated, generate an initial draft of the
129 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
130 for important changes should then be added by hand.  In an ideal world,
131 dual-life modules would have a F<Changes> file that could be cribbed.
132
133 [ Within each section, list entries as a =item entry ]
134
135 =head2 New Modules and Pragmata
136
137 =over 4
138
139 =item *
140
141 XXX
142
143 =back
144
145 =head2 Updated Modules and Pragmata
146
147 =over 4
148
149 =item *
150
151 L<XXX> has been upgraded from version A.xx to B.yy.
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<XXX>
185
186 =over 4
187
188 =item *
189
190 XXX Description of the change here
191
192 =back
193
194 =head1 Diagnostics
195
196 The following additions or changes have been made to diagnostic output,
197 including warnings and fatal error messages.  For the complete list of
198 diagnostic messages, see L<perldiag>.
199
200 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
201 include any changes in L<perldiag> that reconcile it to the C<C> code.
202
203 =head2 New Diagnostics
204
205 XXX Newly added diagnostic messages go under here, separated into New Errors
206 and New Warnings
207
208 =head3 New Errors
209
210 =over 4
211
212 =item *
213
214 XXX L<message|perldiag/"message">
215
216 =back
217
218 =head3 New Warnings
219
220 =over 4
221
222 =item *
223
224 XXX L<message|perldiag/"message">
225
226 =back
227
228 =head2 Changes to Existing Diagnostics
229
230 XXX Changes (i.e. rewording) of diagnostic messages go here
231
232 =over 4
233
234 =item *
235
236 XXX Describe change here
237
238 =back
239
240 =head1 Utility Changes
241
242 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
243 Most of these are built within the directory F<utils>.
244
245 [ List utility changes as a =head2 entry for each utility and =item
246 entries for each change
247 Use L<XXX> with program names to get proper documentation linking. ]
248
249 =head2 L<XXX>
250
251 =over 4
252
253 =item *
254
255 XXX
256
257 =back
258
259 =head1 Configuration and Compilation
260
261 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
262 go here.  Any other changes to the Perl build process should be listed here.
263 However, any platform-specific changes should be listed in the
264 L</Platform Support> section, instead.
265
266 [ List changes as a =item entry ].
267
268 =over 4
269
270 =item *
271
272 XXX
273
274 =back
275
276 =head1 Testing
277
278 XXX Any significant changes to the testing of a freshly built perl should be
279 listed here.  Changes which create B<new> files in F<t/> go here as do any
280 large changes to the testing harness (e.g. when parallel testing was added).
281 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
282 that they represent may be covered elsewhere.
283
284 [ List each test improvement as a =item entry ]
285
286 =over 4
287
288 =item *
289
290 XXX
291
292 =back
293
294 =head1 Platform Support
295
296 XXX Any changes to platform support should be listed in the sections below.
297
298 [ Within the sections, list each platform as a =item entry with specific
299 changes as paragraphs below it. ]
300
301 =head2 New Platforms
302
303 XXX List any platforms that this version of perl compiles on, that previous
304 versions did not.  These will either be enabled by new files in the F<hints/>
305 directories, or new subdirectories and F<README> files at the top level of the
306 source tree.
307
308 =over 4
309
310 =item XXX-some-platform
311
312 XXX
313
314 =back
315
316 =head2 Discontinued Platforms
317
318 XXX List any platforms that this version of perl no longer compiles on.
319
320 =over 4
321
322 =item XXX-some-platform
323
324 XXX
325
326 =back
327
328 =head2 Platform-Specific Notes
329
330 XXX List any changes for specific platforms.  This could include configuration
331 and compilation changes or changes in portability/compatibility.  However,
332 changes within modules for platforms should generally be listed in the
333 L</Modules and Pragmata> section.
334
335 =over 4
336
337 =item VMS
338
339 =over
340
341 =item *
342
343 The minimum supported version of VMS is now v7.3-2, released in 2003.  As a
344 side effect of this change, VAX is no longer supported as the terminal
345 release of OpenVMS VAX was v7.3 in 2001.
346
347 =back
348
349 =back
350
351 =head1 Internal Changes
352
353 XXX Changes which affect the interface available to C<XS> code go here.  Other
354 significant internal changes for future core maintainers should be noted as
355 well.
356
357 [ List each change as a =item entry ]
358
359 =over 4
360
361 =item *
362
363 XXX
364
365 =back
366
367 =head1 Selected Bug Fixes
368
369 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
370 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
371
372 [ List each fix as a =item entry ]
373
374 =over 4
375
376 =item *
377
378 XXX
379
380 =back
381
382 =head1 Known Problems
383
384 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
385 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
386 platform specific bugs also go here.
387
388 [ List each fix as a =item entry ]
389
390 =over 4
391
392 =item *
393
394 XXX
395
396 =back
397
398 =head1 Errata From Previous Releases
399
400 =over 4
401
402 =item *
403
404 XXX Add anything here that we forgot to add, or were mistaken about, in
405 the perldelta of a previous release.
406
407 =back
408
409 =head1 Obituary
410
411 XXX If any significant core contributor has died, we've added a short obituary
412 here.
413
414 =head1 Acknowledgements
415
416 XXX Generate this with:
417
418   perl Porting/acknowledgements.pl v5.23.1..HEAD
419
420 =head1 Reporting Bugs
421
422 If you find what you think is a bug, you might check the articles recently
423 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
424 L<https://rt.perl.org/> .  There may also be information at
425 L<http://www.perl.org/> , the Perl Home Page.
426
427 If you believe you have an unreported bug, please run the L<perlbug> program
428 included with your release.  Be sure to trim your bug down to a tiny but
429 sufficient test case.  Your bug report, along with the output of C<perl -V>,
430 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
431
432 If the bug you are reporting has security implications, which make it
433 inappropriate to send to a publicly archived mailing list, then please send it
434 to perl5-security-report@perl.org.  This points to a closed subscription
435 unarchived mailing list, which includes all the core committers, who will be
436 able to help assess the impact of issues, figure out a resolution, and help
437 co-ordinate the release of patches to mitigate or fix the problem across all
438 platforms on which Perl is supported.  Please only use this address for
439 security issues in the Perl core, not for modules independently distributed on
440 CPAN.
441
442 =head1 SEE ALSO
443
444 The F<Changes> file for an explanation of how to view exhaustive details on
445 what changed.
446
447 The F<INSTALL> file for how to build Perl.
448
449 The F<README> file for general stuff.
450
451 The F<Artistic> and F<Copying> files for copyright information.
452
453 =cut