perldelta for 34213185
[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.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 =head2 readline() with C<$/ = \N> now reads N characters, not N bytes
41
42 Previously, when reading from a stream with I/O layers such as
43 C<encoding>, the readline() function, otherwise known as the C<< <> >>
44 operator, would read I<N> bytes from the top-most layer. [perl #79960]
45
46 Now, I<N> characters are read instead.
47
48 There is no change in behaviour when reading from streams with no
49 extra layers, since bytes map exactly to characters.
50
51 XXX For a release on a stable branch, this section aspires to be:
52
53     There are no changes intentionally incompatible with 5.XXX.XXX
54     If any exist, they are bugs, and we request that you submit a
55     report.  See L</Reporting Bugs> below.
56
57 [ List each incompatible change as a =head2 entry ]
58
59 =head1 Deprecations
60
61 XXX Any deprecated features, syntax, modules etc. should be listed here.  In
62 particular, deprecated modules should be listed here even if they are listed as
63 an updated module in the L</Modules and Pragmata> section.
64
65 [ List each deprecation as a =head2 entry ]
66
67 =head2 Various XS-callable functions are now deprecated
68
69 The following functions will be removed from a future version of Perl,
70 and should not be used.  With participating C compilers (e.g., gcc),
71 compiling any file that uses any of these will generate a warning.
72 These were not intended for public use; there are equivalent, faster,
73 macros for most of them.  See L<perlapi/Character classes>:
74 C<is_uni_ascii>,
75 C<is_uni_ascii_lc>,
76 C<is_uni_blank>,
77 C<is_uni_blank_lc>,
78 C<is_uni_cntrl>,
79 C<is_uni_cntrl_lc>,
80 C<is_uni_idfirst_lc>,
81 C<is_uni_space>,
82 C<is_uni_space_lc>,
83 C<is_uni_xdigit>,
84 C<is_uni_xdigit_lc>,
85 C<is_utf8_ascii>,
86 C<is_utf8_blank>,
87 C<is_utf8_cntrl>,
88 C<is_utf8_idcont>,
89 C<is_utf8_idfirst>,
90 C<is_utf8_perl_space>,
91 C<is_utf8_perl_word>,
92 C<is_utf8_posix_digit>,
93 C<is_utf8_space>,
94 C<is_utf8_xdigit>.
95 C<is_utf8_xidcont>,
96 C<is_utf8_xidfirst>,
97 C<to_uni_lower_lc>,
98 C<to_uni_title_lc>,
99 and
100 C<to_uni_upper_lc>.
101
102 =head1 Performance Enhancements
103
104 XXX Changes which enhance performance without changing behaviour go here.
105 There may well be none in a stable release.
106
107 [ List each enhancement as a =item entry ]
108
109 =over 4
110
111 =item *
112
113 XXX
114
115 =back
116
117 =head1 Modules and Pragmata
118
119 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
120 go here.  If Module::CoreList is updated, generate an initial draft of the
121 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
122 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
123 below.  A paragraph summary for important changes should then be added by hand.
124 In an ideal world, dual-life modules would have a F<Changes> file that could be
125 cribbed.
126
127 [ Within each section, list entries as a =item entry ]
128
129 =head2 New Modules and Pragmata
130
131 =over 4
132
133 =item *
134
135 XXX
136
137 =back
138
139 =head2 Updated Modules and Pragmata
140
141 =over 4
142
143 =item *
144
145 L<XXX> has been upgraded from version A.xx to B.yy.
146
147 =back
148
149 =head2 Removed Modules and Pragmata
150
151 =over 4
152
153 =item *
154
155 XXX
156
157 =back
158
159 =head1 Documentation
160
161 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
162 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
163
164 =head2 New Documentation
165
166 XXX Changes which create B<new> files in F<pod/> go here.
167
168 =head3 L<XXX>
169
170 XXX Description of the purpose of the new file here
171
172 =head2 Changes to Existing Documentation
173
174 XXX Changes which significantly change existing files in F<pod/> go here.
175 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
176 section.
177
178 =head3 L<perlapi/Character classes>
179
180 =over 4
181
182 =item *
183
184 There are quite a few macros callable from XS modules that classify
185 characters into things like alphabetic, punctuation, etc.  More of these
186 are now documented, including ones which work on characters whose code
187 points are outside the Latin-1 range.
188
189 =back
190
191 =head1 Diagnostics
192
193 The following additions or changes have been made to diagnostic output,
194 including warnings and fatal error messages.  For the complete list of
195 diagnostic messages, see L<perldiag>.
196
197 XXX New or changed warnings emitted by the core's C<C> code go here.  Also
198 include any changes in L<perldiag> that reconcile it to the C<C> code.
199
200 =head2 New Diagnostics
201
202 XXX Newly added diagnostic messages go under here, separated into New Errors
203 and New Warnings
204
205 =head3 New Errors
206
207 =over 4
208
209 =item *
210
211 XXX L<message|perldiag/"message">
212
213 =back
214
215 =head3 New Warnings
216
217 =over 4
218
219 =item *
220
221 XXX L<message|perldiag/"message">
222
223 =back
224
225 =head2 Changes to Existing Diagnostics
226
227 XXX Changes (i.e. rewording) of diagnostic messages go here
228
229 =over 4
230
231 =item *
232
233 XXX Describe change here
234
235 =back
236
237 =head1 Utility Changes
238
239 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go here.
240 Most of these are built within the directories F<utils> and F<x2p>.
241
242 [ List utility changes as a =head3 entry for each utility and =item
243 entries for each change
244 Use L<XXX> with program names to get proper documentation linking. ]
245
246 =head3 L<XXX>
247
248 =over 4
249
250 =item *
251
252 XXX
253
254 =back
255
256 =head1 Configuration and Compilation
257
258 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
259 go here.  Any other changes to the Perl build process should be listed here.
260 However, any platform-specific changes should be listed in the
261 L</Platform Support> section, instead.
262
263 [ List changes as a =item entry ].
264
265 =over 4
266
267 =item *
268
269 XXX
270
271 =back
272
273 =head1 Testing
274
275 XXX Any significant changes to the testing of a freshly built perl should be
276 listed here.  Changes which create B<new> files in F<t/> go here as do any
277 large changes to the testing harness (e.g. when parallel testing was added).
278 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
279 that they represent may be covered elsewhere.
280
281 [ List each test improvement as a =item entry ]
282
283 =over 4
284
285 =item *
286
287 XXX
288
289 =back
290
291 =head1 Platform Support
292
293 XXX Any changes to platform support should be listed in the sections below.
294
295 [ Within the sections, list each platform as a =item entry with specific
296 changes as paragraphs below it. ]
297
298 =head2 New Platforms
299
300 XXX List any platforms that this version of perl compiles on, that previous
301 versions did not.  These will either be enabled by new files in the F<hints/>
302 directories, or new subdirectories and F<README> files at the top level of the
303 source tree.
304
305 =over 4
306
307 =item XXX-some-platform
308
309 XXX
310
311 =back
312
313 =head2 Discontinued Platforms
314
315 XXX List any platforms that this version of perl no longer compiles on.
316
317 =over 4
318
319 =item XXX-some-platform
320
321 XXX
322
323 =back
324
325 =head2 Platform-Specific Notes
326
327 XXX List any changes for specific platforms.  This could include configuration
328 and compilation changes or changes in portability/compatibility.  However,
329 changes within modules for platforms should generally be listed in the
330 L</Modules and Pragmata> section.
331
332 =over 4
333
334 =item XXX-some-platform
335
336 XXX
337
338 =back
339
340 =head1 Internal Changes
341
342 XXX Changes which affect the interface available to C<XS> code go here.  Other
343 significant internal changes for future core maintainers should be noted as
344 well.
345
346 [ List each change as a =item entry ]
347
348 =over 4
349
350 =item *
351
352 XXX
353
354 =back
355
356 =head1 Selected Bug Fixes
357
358 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
359 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
360
361 [ List each fix as a =item entry ]
362
363 =over 4
364
365 =item *
366
367 XXX
368
369 =back
370
371 =head1 Known Problems
372
373 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
374 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
375 platform specific bugs also go here.
376
377 [ List each fix as a =item entry ]
378
379 =over 4
380
381 =item *
382
383 XXX
384
385 =back
386
387 =head1 Obituary
388
389 XXX If any significant core contributor has died, we've added a short obituary
390 here.
391
392 =head1 Acknowledgements
393
394 XXX Generate this with:
395
396   perl Porting/acknowledgements.pl v5.17.6..HEAD
397
398 =head1 Reporting Bugs
399
400 If you find what you think is a bug, you might check the articles recently
401 posted to the comp.lang.perl.misc newsgroup and the perl bug database at
402 http://rt.perl.org/perlbug/ .  There may also be information at
403 http://www.perl.org/ , the Perl Home Page.
404
405 If you believe you have an unreported bug, please run the L<perlbug> program
406 included with your release.  Be sure to trim your bug down to a tiny but
407 sufficient test case.  Your bug report, along with the output of C<perl -V>,
408 will be sent off to perlbug@perl.org to be analysed by the Perl porting team.
409
410 If the bug you are reporting has security implications, which make it
411 inappropriate to send to a publicly archived mailing list, then please send it
412 to perl5-security-report@perl.org.  This points to a closed subscription
413 unarchived mailing list, which includes all the core committers, who will be
414 able to help assess the impact of issues, figure out a resolution, and help
415 co-ordinate the release of patches to mitigate or fix the problem across all
416 platforms on which Perl is supported.  Please only use this address for
417 security issues in the Perl core, not for modules independently distributed on
418 CPAN.
419
420 =head1 SEE ALSO
421
422 The F<Changes> file for an explanation of how to view exhaustive details on
423 what changed.
424
425 The F<INSTALL> file for how to build Perl.
426
427 The F<README> file for general stuff.
428
429 The F<Artistic> and F<Copying> files for copyright information.
430
431 =cut