This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Correct lock’s prototype
[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
6 XXX needs to be processed before release. ]
7
8 perldelta - what is new for perl v5.15.2
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.15.1 release and
13 the 5.15.2 release.
14
15 If you are upgrading from an earlier release such as 5.15.0, first read
16 L<perl5151delta>, which describes differences between 5.15.0 and
17 5.15.1.
18
19 =head1 Notice
20
21 XXX Any important notices here
22
23 =head1 Core Enhancements
24
25 XXX New core language features go here. Summarise user-visible core language
26 enhancements. Particularly prominent performance optimisations could go
27 here, but most should go in the L</Performance Enhancements> section.
28
29 [ List each enhancement as a =head2 entry ]
30
31 =head1 Security
32
33 XXX Any security-related notices go here.  In particular, any security
34 vulnerabilities closed should be noted here rather than in the
35 L</Selected Bug Fixes> section.
36
37 [ List each security issue as a =head2 entry ]
38
39 =head1 Incompatible Changes
40
41 XXX For a release on a stable branch, this section aspires to be:
42
43     There are no changes intentionally incompatible with 5.XXX.XXX
44     If any exist, they are bugs and reports are welcome.
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 In particular, deprecated modules should be listed here even if they are
52 listed as an updated module in the L</Modules and Pragmata> section.
53
54 [ List each deprecation as a =head2 entry ]
55
56 =head1 Performance Enhancements
57
58 XXX Changes which enhance performance without changing behaviour go here. There
59 may well be none in a stable release.
60
61 [ List each enhancement as a =item entry ]
62
63 =over 4
64
65 =item *
66
67 XXX
68
69 =back
70
71 =head1 Modules and Pragmata
72
73 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
74 go here.  If Module::CoreList is updated, generate an initial draft of the
75 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
76 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
77 below.  A paragraph summary for important changes should then be added by hand.
78 In an ideal world, dual-life modules would have a F<Changes> file that could be
79 cribbed.
80
81 [ Within each section, list entries as a =item entry ]
82
83 =head2 New Modules and Pragmata
84
85 =over 4
86
87 =item *
88
89 XXX
90
91 =back
92
93 =head2 Updated Modules and Pragmata
94
95 =over 4
96
97 =item *
98
99 L<ExtUtils::Install> has been upgraded from version 1.56 to version 1.57.
100
101 There is no change to ExtUtils::Install other than the version number
102 increase, but L<ExtUtils::Installed> has been upgraded from version 1.999_001
103 to vesion 1.999002 and a new C<skip_cwd> attribute has been added.
104
105 =back
106
107 =head2 Removed Modules and Pragmata
108
109 =over 4
110
111 =item *
112
113 XXX
114
115 =back
116
117 =head1 Documentation
118
119 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
120 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
121
122 =head2 New Documentation
123
124 XXX Changes which create B<new> files in F<pod/> go here.
125
126 =head3 L<XXX>
127
128 XXX Description of the purpose of the new file here
129
130 =head2 Changes to Existing Documentation
131
132 XXX Changes which significantly change existing files in F<pod/> go here.
133 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
134 section.
135
136 =head3 L<XXX>
137
138 =over 4
139
140 =item *
141
142 XXX Description of the change here
143
144 =back
145
146 =head1 Diagnostics
147
148 The following additions or changes have been made to diagnostic output,
149 including warnings and fatal error messages.  For the complete list of
150 diagnostic messages, see L<perldiag>.
151
152 XXX New or changed warnings emitted by the core's C<C> code go here. Also
153 include any changes in L<perldiag> that reconcile it to the C<C> code.
154
155 [ Within each section, list entries as a =item entry that links to perldiag,
156   e.g.
157
158   =item *
159
160   L<Invalid version object|perldiag/"Invalid version object">
161 ]
162
163 =head2 New Diagnostics
164
165 XXX Newly added diagnostic messages go here
166
167 =head3 New Errors
168
169 =over 4
170
171 =item *
172
173 XXX L<message|perldiag/"message">
174
175 =back
176
177 =head3 New Warnings
178
179 =over 4
180
181 =item *
182
183 XXX L<message|perldiag/"message">
184
185 =back
186
187 =head2 Changes to Existing Diagnostics
188
189 XXX Changes (i.e. rewording) of diagnostic messages go here
190
191 =over 4
192
193 =item *
194
195 XXX Describe change here
196
197 =back
198
199 =head1 Utility Changes
200
201 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
202 here. Most of these are built within the directories F<utils> and F<x2p>.
203
204 [ List utility changes as a =head3 entry for each utility and =item
205 entries for each change
206 Use L<XXX> with program names to get proper documentation linking. ]
207
208 =head3 L<perlivp>
209
210 =over 4
211
212 =item *
213
214 Fixed a bug whereby other perls under the current directory could cause
215 false positive failures.
216
217 =item *
218
219 Tests for .ph files have been removed, as these test have been optional since
220 2005 and .ph files are no longer generated during installation.
221
222 =back
223
224 =head1 Configuration and Compilation
225
226 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
227 go here.  Any other changes to the Perl build process should be listed here.
228 However, any platform-specific changes should be listed in the
229 L</Platform Support> section, instead.
230
231 [ List changes as a =item entry ].
232
233 =over 4
234
235 =item *
236
237 XXX
238
239 =back
240
241 =head1 Testing
242
243 XXX Any significant changes to the testing of a freshly built perl should be
244 listed here.  Changes which create B<new> files in F<t/> go here as do any
245 large changes to the testing harness (e.g. when parallel testing was added).
246 Changes to existing files in F<t/> aren't worth summarising, although the bugs
247 that they represent may be covered elsewhere.
248
249 [ List each test improvement as a =item entry ]
250
251 =over 4
252
253 =item *
254
255 XXX
256
257 =back
258
259 =head1 Platform Support
260
261 XXX Any changes to platform support should be listed in the sections below.
262
263 [ Within the sections, list each platform as a =item entry with specific
264 changes as paragraphs below it. ]
265
266 =head2 New Platforms
267
268 XXX List any platforms that this version of perl compiles on, that previous
269 versions did not. These will either be enabled by new files in the F<hints/>
270 directories, or new subdirectories and F<README> files at the top level of the
271 source tree.
272
273 =over 4
274
275 =item XXX-some-platform
276
277 XXX
278
279 =back
280
281 =head2 Discontinued Platforms
282
283 XXX List any platforms that this version of perl no longer compiles on.
284
285 =over 4
286
287 =item XXX-some-platform
288
289 XXX
290
291 =back
292
293 =head2 Platform-Specific Notes
294
295 XXX List any changes for specific platforms. This could include configuration
296 and compilation changes or changes in portability/compatibility.  However,
297 changes within modules for platforms should generally be listed in the
298 L</Modules and Pragmata> section.
299
300 =over 4
301
302 =item XXX-some-platform
303
304 XXX
305
306 =back
307
308 =head1 Internal Changes
309
310 XXX Changes which affect the interface available to C<XS> code go here.
311 Other significant internal changes for future core maintainers should
312 be noted as well.
313
314 [ List each change as a =item entry ]
315
316 =over 4
317
318 =item *
319
320 XXX
321
322 =back
323
324 =head1 Selected Bug Fixes
325
326 XXX Important bug fixes in the core language are summarised here.
327 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
328 L</Modules and Pragmata>.
329
330 [ List each fix as a =item entry ]
331
332 =over 4
333
334 =item *
335
336 Locking an lvalue subroutine (via C<lock &lvsub>) now locks the return
337 value, instead of trying to lock the sub (which has no effect).  It also no
338 longer tries to return the sub as a scalar, resulting in strange side
339 effects like C<ref \$_> returning "CODE" in some instances.
340
341 =item *
342
343 C<lock>'s prototype has been corrected to C<(\[$@%*])> from C<(\$)>, which
344 was just wrong.
345
346 =back
347
348 =head1 Known Problems
349
350 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
351 tests that had to be C<TODO>ed for the release would be noted here, unless
352 they were specific to a particular platform (see below).
353
354 This is a list of some significant unfixed bugs, which are regressions
355 from either 5.XXX.XXX or 5.XXX.XXX.
356
357 [ List each fix as a =item entry ]
358
359 =over 4
360
361 =item *
362
363 XXX
364
365 =back
366
367 =head1 Obituary
368
369 XXX If any significant core contributor has died, we've added a short obituary
370 here.
371
372 =head1 Acknowledgements
373
374 XXX Generate this with:
375
376   perl Porting/acknowledgements.pl v5.15.1..HEAD
377
378 =head1 Reporting Bugs
379
380 If you find what you think is a bug, you might check the articles
381 recently posted to the comp.lang.perl.misc newsgroup and the perl
382 bug database at http://rt.perl.org/perlbug/ .  There may also be
383 information at http://www.perl.org/ , the Perl Home Page.
384
385 If you believe you have an unreported bug, please run the L<perlbug>
386 program included with your release.  Be sure to trim your bug down
387 to a tiny but sufficient test case.  Your bug report, along with the
388 output of C<perl -V>, will be sent off to perlbug@perl.org to be
389 analysed by the Perl porting team.
390
391 If the bug you are reporting has security implications, which make it
392 inappropriate to send to a publicly archived mailing list, then please send
393 it to perl5-security-report@perl.org. This points to a closed subscription
394 unarchived mailing list, which includes
395 all the core committers, who will be able
396 to help assess the impact of issues, figure out a resolution, and help
397 co-ordinate the release of patches to mitigate or fix the problem across all
398 platforms on which Perl is supported. Please only use this address for
399 security issues in the Perl core, not for modules independently
400 distributed on CPAN.
401
402 =head1 SEE ALSO
403
404 The F<Changes> file for an explanation of how to view exhaustive details
405 on what changed.
406
407 The F<INSTALL> file for how to build Perl.
408
409 The F<README> file for general stuff.
410
411 The F<Artistic> and F<Copying> files for copyright information.
412
413 =cut