op.c: Fix linux g++ compilation
[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.21.7
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.21.6 release and the 5.21.7
13 release.
14
15 If you are upgrading from an earlier release such as 5.21.5, first read
16 L<perl5216delta>, which describes differences between 5.21.5 and 5.21.6.
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 =item XXX
73
74 XXX Note that deprecated modules should be listed here even if they are listed
75 as an updated module in the L</Modules and Pragmata> section.
76
77 =back
78
79 [ List each other deprecation as a =head2 entry ]
80
81 =head2 Setting C<${^ENCODING}> to anything but C<undef>
82
83 This variable allows Perl scripts to be written in a non-ASCII,
84 non-UTF-8 encoding.  However, it affects all modules globally, leading
85 to wrong answers and segmentation faults.  New scripts should be written
86 in UTF-8; old scripts should be converted to UTF-8, which is easily done
87 with the L<encoding> pragma.
88
89 =head1 Performance Enhancements
90
91 XXX Changes which enhance performance without changing behaviour go here.
92 There may well be none in a stable release.
93
94 [ List each enhancement as a =item entry ]
95
96 =over 4
97
98 =item *
99
100 XXX
101
102 =back
103
104 =head1 Modules and Pragmata
105
106 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
107 go here.  If Module::CoreList is updated, generate an initial draft of the
108 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
109 for important changes should then be added by hand.  In an ideal world,
110 dual-life modules would have a F<Changes> file that could be cribbed.
111
112 [ Within each section, list entries as a =item entry ]
113
114 =head2 New Modules and Pragmata
115
116 =over 4
117
118 =item *
119
120 XXX
121
122 =back
123
124 =head2 Updated Modules and Pragmata
125
126 =over 4
127
128 =item *
129
130 L<ExtUtils::ParseXS> has been upgraded from version 3.26 to 3.27.
131
132 Only declare C<file> unused if we actually define it.
133
134 Improve generated C<RETVAL> code generation to avoid repeated
135 references to C<ST(0)>.  [perl #123278]
136
137 =back
138
139 =head2 Removed Modules and Pragmata
140
141 =over 4
142
143 =item *
144
145 XXX
146
147 =back
148
149 =head1 Documentation
150
151 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
152 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
153
154 =head2 New Documentation
155
156 XXX Changes which create B<new> files in F<pod/> go here.
157
158 =head3 L<XXX>
159
160 XXX Description of the purpose of the new file here
161
162 =head2 Changes to Existing Documentation
163
164 XXX Changes which significantly change existing files in F<pod/> go here.
165 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
166 section.
167
168 =head3 L<XXX>
169
170 =over 4
171
172 =item *
173
174 XXX Description of the change here
175
176 =back
177
178 =head1 Diagnostics
179
180 The following additions or changes have been made to diagnostic output,
181 including warnings and fatal error messages.  For the complete list of
182 diagnostic messages, see L<perldiag>.
183
184 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
185 include any changes in L<perldiag> that reconcile it to the C<C> code.
186
187 =head2 New Diagnostics
188
189 XXX Newly added diagnostic messages go under here, separated into New Errors
190 and New Warnings
191
192 =head3 New Errors
193
194 =over 4
195
196 =item *
197
198 XXX L<message|perldiag/"message">
199
200 =back
201
202 =head3 New Warnings
203
204 =over 4
205
206 =item *
207
208 XXX L<message|perldiag/"message">
209
210 =back
211
212 =head2 Changes to Existing Diagnostics
213
214 XXX Changes (i.e. rewording) of diagnostic messages go here
215
216 =over 4
217
218 =item *
219
220 XXX Describe change here
221
222 =back
223
224 =head1 Utility Changes
225
226 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
227 Most of these are built within the directory F<utils>.
228
229 [ List utility changes as a =head2 entry for each utility and =item
230 entries for each change
231 Use L<XXX> with program names to get proper documentation linking. ]
232
233 =head2 L<XXX>
234
235 =over 4
236
237 =item *
238
239 XXX
240
241 =back
242
243 =head1 Configuration and Compilation
244
245 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
246 go here.  Any other changes to the Perl build process should be listed here.
247 However, any platform-specific changes should be listed in the
248 L</Platform Support> section, instead.
249
250 [ List changes as a =item entry ].
251
252 =over 4
253
254 =item *
255
256 XXX
257
258 =back
259
260 =head1 Testing
261
262 XXX Any significant changes to the testing of a freshly built perl should be
263 listed here.  Changes which create B<new> files in F<t/> go here as do any
264 large changes to the testing harness (e.g. when parallel testing was added).
265 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
266 that they represent may be covered elsewhere.
267
268 [ List each test improvement as a =item entry ]
269
270 =over 4
271
272 =item *
273
274 XXX
275
276 =back
277
278 =head1 Platform Support
279
280 XXX Any changes to platform support should be listed in the sections below.
281
282 [ Within the sections, list each platform as a =item entry with specific
283 changes as paragraphs below it. ]
284
285 =head2 New Platforms
286
287 XXX List any platforms that this version of perl compiles on, that previous
288 versions did not.  These will either be enabled by new files in the F<hints/>
289 directories, or new subdirectories and F<README> files at the top level of the
290 source tree.
291
292 =over 4
293
294 =item XXX-some-platform
295
296 XXX
297
298 =back
299
300 =head2 Discontinued Platforms
301
302 XXX List any platforms that this version of perl no longer compiles on.
303
304 =over 4
305
306 =item XXX-some-platform
307
308 XXX
309
310 =back
311
312 =head2 Platform-Specific Notes
313
314 XXX List any changes for specific platforms.  This could include configuration
315 and compilation changes or changes in portability/compatibility.  However,
316 changes within modules for platforms should generally be listed in the
317 L</Modules and Pragmata> section.
318
319 =over 4
320
321 =item XXX-some-platform
322
323 XXX
324
325 =back
326
327 =head1 Internal Changes
328
329 XXX Changes which affect the interface available to C<XS> code go here.  Other
330 significant internal changes for future core maintainers should be noted as
331 well.
332
333 [ List each change as a =item entry ]
334
335 =over 4
336
337 =item *
338
339 XXX
340
341 =back
342
343 =head1 Selected Bug Fixes
344
345 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
346 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
347
348 [ List each fix as a =item entry ]
349
350 =over 4
351
352 =item *
353
354 XXX
355
356 =item *
357
358 The L<encoding> pragma's effect is now limited to lexical scope.  This
359 pragma is deprecated, but in the meantime, it could adversely affect
360 unrelated modules that are included in the same program.
361
362 =back
363
364 =head1 Known Problems
365
366 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
367 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
368 platform specific bugs also go here.
369
370 [ List each fix as a =item entry ]
371
372 =over 4
373
374 =item *
375
376 XXX
377
378 =back
379
380 =head1 Errata From Previous Releases
381
382 =over 4
383
384 =item *
385
386 XXX Add anything here that we forgot to add, or were mistaken about, in
387 the perldelta of a previous release.
388
389 =back
390
391 =head1 Obituary
392
393 XXX If any significant core contributor has died, we've added a short obituary
394 here.
395
396 =head1 Acknowledgements
397
398 XXX Generate this with:
399
400   perl Porting/acknowledgements.pl v5.21.6..HEAD
401
402 =head1 Reporting Bugs
403
404 If you find what you think is a bug, you might check the articles recently
405 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
406 https://rt.perl.org/ .  There may also be information at
407 http://www.perl.org/ , the Perl Home Page.
408
409 If you believe you have an unreported bug, please run the L<perlbug> program
410 included with your release.  Be sure to trim your bug down to a tiny but
411 sufficient test case.  Your bug report, along with the output of C<perl -V>,
412 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
413
414 If the bug you are reporting has security implications, which make it
415 inappropriate to send to a publicly archived mailing list, then please send it
416 to perl5-security-report@perl.org.  This points to a closed subscription
417 unarchived mailing list, which includes all the core committers, who will be
418 able to help assess the impact of issues, figure out a resolution, and help
419 co-ordinate the release of patches to mitigate or fix the problem across all
420 platforms on which Perl is supported.  Please only use this address for
421 security issues in the Perl core, not for modules independently distributed on
422 CPAN.
423
424 =head1 SEE ALSO
425
426 The F<Changes> file for an explanation of how to view exhaustive details on
427 what changed.
428
429 The F<INSTALL> file for how to build Perl.
430
431 The F<README> file for general stuff.
432
433 The F<Artistic> and F<Copying> files for copyright information.
434
435 =cut