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