This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
handy.h: Change documentation for perlapi
[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.17.7
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.17.6 release and the 5.17.7
13 release.
14
15 If you are upgrading from an earlier release such as 5.17.5, first read
16 L<perl5176delta>, which describes differences between 5.17.5 and 5.17.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.  In
51 particular, deprecated modules should be listed here even if they are listed as
52 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.
59 There 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<XXX> has been upgraded from version A.xx to B.yy.
100
101 =back
102
103 =head2 Removed Modules and Pragmata
104
105 =over 4
106
107 =item *
108
109 XXX
110
111 =back
112
113 =head1 Documentation
114
115 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
116 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
117
118 =head2 New Documentation
119
120 XXX Changes which create B<new> files in F<pod/> go here.
121
122 =head3 L<XXX>
123
124 XXX Description of the purpose of the new file here
125
126 =head2 Changes to Existing Documentation
127
128 XXX Changes which significantly change existing files in F<pod/> go here.
129 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
130 section.
131
132 =head3 L<perlapi/Character classes>
133
134 =over 4
135
136 =item *
137
138 There are quite a few macros callable from XS modules that classify
139 characters into things like alphabetic, punctuation, etc.  More of these
140 are now documented, including ones which work on characters whose code
141 points are outside the Latin-1 range.
142
143 =back
144
145 =head1 Diagnostics
146
147 The following additions or changes have been made to diagnostic output,
148 including warnings and fatal error messages.  For the complete list of
149 diagnostic messages, see L<perldiag>.
150
151 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
152 include any changes in L<perldiag> that reconcile it to the C<C> code.
153
154 =head2 New Diagnostics
155
156 XXX Newly added diagnostic messages go under here, separated into New Errors
157 and New Warnings
158
159 =head3 New Errors
160
161 =over 4
162
163 =item *
164
165 XXX L<message|perldiag/"message">
166
167 =back
168
169 =head3 New Warnings
170
171 =over 4
172
173 =item *
174
175 XXX L<message|perldiag/"message">
176
177 =back
178
179 =head2 Changes to Existing Diagnostics
180
181 XXX Changes (i.e. rewording) of diagnostic messages go here
182
183 =over 4
184
185 =item *
186
187 XXX Describe change here
188
189 =back
190
191 =head1 Utility Changes
192
193 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
194 Most of these are built within the directories F<utils> and F<x2p>.
195
196 [ List utility changes as a =head3 entry for each utility and =item
197 entries for each change
198 Use L<XXX> with program names to get proper documentation linking. ]
199
200 =head3 L<XXX>
201
202 =over 4
203
204 =item *
205
206 XXX
207
208 =back
209
210 =head1 Configuration and Compilation
211
212 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
213 go here.  Any other changes to the Perl build process should be listed here.
214 However, any platform-specific changes should be listed in the
215 L</Platform Support> section, instead.
216
217 [ List changes as a =item entry ].
218
219 =over 4
220
221 =item *
222
223 XXX
224
225 =back
226
227 =head1 Testing
228
229 XXX Any significant changes to the testing of a freshly built perl should be
230 listed here.  Changes which create B<new> files in F<t/> go here as do any
231 large changes to the testing harness (e.g. when parallel testing was added).
232 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
233 that they represent may be covered elsewhere.
234
235 [ List each test improvement as a =item entry ]
236
237 =over 4
238
239 =item *
240
241 XXX
242
243 =back
244
245 =head1 Platform Support
246
247 XXX Any changes to platform support should be listed in the sections below.
248
249 [ Within the sections, list each platform as a =item entry with specific
250 changes as paragraphs below it. ]
251
252 =head2 New Platforms
253
254 XXX List any platforms that this version of perl compiles on, that previous
255 versions did not.  These will either be enabled by new files in the F<hints/>
256 directories, or new subdirectories and F<README> files at the top level of the
257 source tree.
258
259 =over 4
260
261 =item XXX-some-platform
262
263 XXX
264
265 =back
266
267 =head2 Discontinued Platforms
268
269 XXX List any platforms that this version of perl no longer compiles on.
270
271 =over 4
272
273 =item XXX-some-platform
274
275 XXX
276
277 =back
278
279 =head2 Platform-Specific Notes
280
281 XXX List any changes for specific platforms.  This could include configuration
282 and compilation changes or changes in portability/compatibility.  However,
283 changes within modules for platforms should generally be listed in the
284 L</Modules and Pragmata> section.
285
286 =over 4
287
288 =item XXX-some-platform
289
290 XXX
291
292 =back
293
294 =head1 Internal Changes
295
296 XXX Changes which affect the interface available to C<XS> code go here.  Other
297 significant internal changes for future core maintainers should be noted as
298 well.
299
300 [ List each change as a =item entry ]
301
302 =over 4
303
304 =item *
305
306 XXX
307
308 =back
309
310 =head1 Selected Bug Fixes
311
312 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
313 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
314
315 [ List each fix as a =item entry ]
316
317 =over 4
318
319 =item *
320
321 XXX
322
323 =back
324
325 =head1 Known Problems
326
327 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
328 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
329 platform specific bugs also go here.
330
331 [ List each fix as a =item entry ]
332
333 =over 4
334
335 =item *
336
337 XXX
338
339 =back
340
341 =head1 Obituary
342
343 XXX If any significant core contributor has died, we've added a short obituary
344 here.
345
346 =head1 Acknowledgements
347
348 XXX Generate this with:
349
350   perl Porting/acknowledgements.pl v5.17.6..HEAD
351
352 =head1 Reporting Bugs
353
354 If you find what you think is a bug, you might check the articles recently
355 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
356 http://rt.perl.org/perlbug/ .  There may also be information at
357 http://www.perl.org/ , the Perl Home Page.
358
359 If you believe you have an unreported bug, please run the L<perlbug> program
360 included with your release.  Be sure to trim your bug down to a tiny but
361 sufficient test case.  Your bug report, along with the output of C<perl -V>,
362 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
363
364 If the bug you are reporting has security implications, which make it
365 inappropriate to send to a publicly archived mailing list, then please send it
366 to perl5-security-report@perl.org.  This points to a closed subscription
367 unarchived mailing list, which includes all the core committers, who will be
368 able to help assess the impact of issues, figure out a resolution, and help
369 co-ordinate the release of patches to mitigate or fix the problem across all
370 platforms on which Perl is supported.  Please only use this address for
371 security issues in the Perl core, not for modules independently distributed on
372 CPAN.
373
374 =head1 SEE ALSO
375
376 The F<Changes> file for an explanation of how to view exhaustive details on
377 what changed.
378
379 The F<INSTALL> file for how to build Perl.
380
381 The F<README> file for general stuff.
382
383 The F<Artistic> and F<Copying> files for copyright information.
384
385 =cut