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