This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Add "run makedepend in parallel" to perldelta
[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.35.3
9
10 =head1 DESCRIPTION
11
12 This document describes differences between the 5.35.2 release and the 5.35.3
13 release.
14
15 If you are upgrading from an earlier release such as 5.35.1, first read
16 L<perl5352delta>, which describes differences between 5.35.1 and 5.35.2.
17
18 =head1 Notice
19
20 With this release, the experimental C<switch> feature, present in every feature
21 bundle since they were introduced in v5.10, has been removed from the v5.36
22 bundle.  If you want to live dangerously and use it, you'll have to enable it
23 explicitly.
24
25 =head1 Core Enhancements
26
27 XXX New core language features go here.  Summarize user-visible core language
28 enhancements.  Particularly prominent performance optimisations could go
29 here, but most should go in the L</Performance Enhancements> section.
30
31 [ List each enhancement as a =head2 entry ]
32
33 =head1 Security
34
35 XXX Any security-related notices go here.  In particular, any security
36 vulnerabilities closed should be noted here rather than in the
37 L</Selected Bug Fixes> section.
38
39 [ List each security issue as a =head2 entry ]
40
41 =head1 Incompatible Changes
42
43 XXX For a release on a stable branch, this section aspires to be:
44
45     There are no changes intentionally incompatible with 5.XXX.XXX
46     If any exist, they are bugs, and we request that you submit a
47     report.  See L</Reporting Bugs> below.
48
49 [ List each incompatible change as a =head2 entry ]
50
51 =head1 Deprecations
52
53 XXX Any deprecated features, syntax, modules etc. should be listed here.
54
55 =head2 Module removals
56
57 XXX Remove this section if not applicable.
58
59 The following modules will be removed from the core distribution in a
60 future release, and will at that time need to be installed from CPAN.
61 Distributions on CPAN which require these modules will need to list them as
62 prerequisites.
63
64 The core versions of these modules will now issue C<"deprecated">-category
65 warnings to alert you to this fact.  To silence these deprecation warnings,
66 install the modules in question from CPAN.
67
68 Note that these are (with rare exceptions) fine modules that you are encouraged
69 to continue to use.  Their disinclusion from core primarily hinges on their
70 necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
71 not usually on concerns over their design.
72
73 =over
74
75 =item XXX
76
77 XXX Note that deprecated modules should be listed here even if they are listed
78 as an updated module in the L</Modules and Pragmata> section.
79
80 =back
81
82 [ List each other deprecation as a =head2 entry ]
83
84 =head1 Performance Enhancements
85
86 XXX Changes which enhance performance without changing behaviour go here.
87 There may well be none in a stable release.
88
89 [ List each enhancement as an =item entry ]
90
91 =over 4
92
93 =item *
94
95 XXX
96
97 =back
98
99 =head1 Modules and Pragmata
100
101 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
102 go here.  If Module::CoreList is updated, generate an initial draft of the
103 following sections using F<Porting/corelist-perldelta.pl>.  A paragraph summary
104 for important changes should then be added by hand.  In an ideal world,
105 dual-life modules would have a F<Changes> file that could be cribbed.
106
107 The list of new and updated modules is modified automatically as part of
108 preparing a Perl release, so the only reason to manually add entries here is if
109 you're summarising the important changes in the module update. (Also, if the
110 manually-added details don't match the automatically-generated ones, the
111 release manager will have to investigate the situation carefully.)
112
113 [ Within each section, list entries as an =item entry ]
114
115 =head2 New Modules and Pragmata
116
117 =over 4
118
119 =item *
120
121 XXX Remove this section if not applicable.
122
123 =back
124
125 =head2 Updated Modules and Pragmata
126
127 =over 4
128
129 =item *
130
131 L<Text::Tabs> and L<Text::Wrap> have been upgraded from CPAN (Text-Tabs+Wrap)
132 version 2013.0523 to 2021.0804.
133
134 =item *
135
136 L<Pod::Html> has been upgraded from version 1.31 to 1.32.
137
138 =item *
139
140 L<XXX> has been upgraded from version A.xx to B.yy.
141
142 If there was something important to note about this change, include that here.
143
144 =back
145
146 =head2 Removed Modules and Pragmata
147
148 =over 4
149
150 =item *
151
152 XXX
153
154 =back
155
156 =head1 Documentation
157
158 XXX Changes to files in F<pod/> go here.  Consider grouping entries by
159 file and be sure to link to the appropriate page, e.g. L<perlfunc>.
160
161 =head2 New Documentation
162
163 XXX Changes which create B<new> files in F<pod/> go here.
164
165 =head3 L<XXX>
166
167 XXX Description of the purpose of the new file here
168
169 =head2 Changes to Existing Documentation
170
171 We have attempted to update the documentation to reflect the changes
172 listed in this document.  If you find any we have missed, open an issue
173 at L<https://github.com/Perl/perl5/issues>.
174
175 XXX Changes which significantly change existing files in F<pod/> go here.
176 However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
177 section.
178
179 Additionally, the following selected changes have been made:
180
181 =head3 L<XXX>
182
183 =over 4
184
185 =item *
186
187 XXX Description of the change here
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<perldoc> and F<xsubpp> go here.
240 Most of these are built within the directory F<utils>.
241
242 [ List utility changes as a =head2 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 =head2 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 an =item entry ].
264
265 =over 4
266
267 =item *
268
269 The makedepend step is now run in parallel by using make
270
271 This reduces the time for
272
273   time sh ./makedepend MAKE=make cflags
274
275 from 5 seconds to 2 seconds with MAKEFLAGS=-j8
276
277 =back
278
279 =head1 Testing
280
281 XXX Any significant changes to the testing of a freshly built perl should be
282 listed here.  Changes which create B<new> files in F<t/> go here as do any
283 large changes to the testing harness (e.g. when parallel testing was added).
284 Changes to existing files in F<t/> aren't worth summarizing, although the bugs
285 that they represent may be covered elsewhere.
286
287 XXX If there were no significant test changes, say this:
288
289 Tests were added and changed to reflect the other additions and changes
290 in this release.
291
292 XXX If instead there were significant changes, say this:
293
294 Tests were added and changed to reflect the other additions and
295 changes in this release.  Furthermore, these significant changes were
296 made:
297
298 [ List each test improvement as an =item entry ]
299
300 =over 4
301
302 =item *
303
304 XXX
305
306 =back
307
308 =head1 Platform Support
309
310 XXX Any changes to platform support should be listed in the sections below.
311
312 [ Within the sections, list each platform as an =item entry with specific
313 changes as paragraphs below it. ]
314
315 =head2 New Platforms
316
317 XXX List any platforms that this version of perl compiles on, that previous
318 versions did not.  These will either be enabled by new files in the F<hints/>
319 directories, or new subdirectories and F<README> files at the top level of the
320 source tree.
321
322 =over 4
323
324 =item XXX-some-platform
325
326 XXX
327
328 =back
329
330 =head2 Discontinued Platforms
331
332 XXX List any platforms that this version of perl no longer compiles on.
333
334 =over 4
335
336 =item XXX-some-platform
337
338 XXX
339
340 =back
341
342 =head2 Platform-Specific Notes
343
344 XXX List any changes for specific platforms.  This could include configuration
345 and compilation changes or changes in portability/compatibility.  However,
346 changes within modules for platforms should generally be listed in the
347 L</Modules and Pragmata> section.
348
349 =over 4
350
351 =item XXX-some-platform
352
353 XXX
354
355 =back
356
357 =head1 Internal Changes
358
359 XXX Changes which affect the interface available to C<XS> code go here.  Other
360 significant internal changes for future core maintainers should be noted as
361 well.
362
363 [ List each change as an =item entry ]
364
365 =over 4
366
367 =item *
368
369 XXX
370
371 =back
372
373 =head1 Selected Bug Fixes
374
375 XXX Important bug fixes in the core language are summarized here.  Bug fixes in
376 files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
377
378 [ List each fix as an =item entry ]
379
380 =over 4
381
382 =item *
383
384 XXX
385
386 =back
387
388 =head1 Known Problems
389
390 XXX Descriptions of platform agnostic bugs we know we can't fix go here.  Any
391 tests that had to be C<TODO>ed for the release would be noted here.  Unfixed
392 platform specific bugs also go here.
393
394 [ List each fix as an =item entry ]
395
396 =over 4
397
398 =item *
399
400 XXX
401
402 =back
403
404 =head1 Errata From Previous Releases
405
406 =over 4
407
408 =item *
409
410 XXX Add anything here that we forgot to add, or were mistaken about, in
411 the perldelta of a previous release.
412
413 =back
414
415 =head1 Obituary
416
417 XXX If any significant core contributor or member of the CPAN community has
418 died, add a short obituary here.
419
420 =head1 Acknowledgements
421
422 XXX Generate this with:
423
424   perl Porting/acknowledgements.pl v5.35.2..HEAD
425
426 =head1 Reporting Bugs
427
428 If you find what you think is a bug, you might check the perl bug database
429 at L<https://github.com/Perl/perl5/issues>.  There may also be information at
430 L<http://www.perl.org/>, the Perl Home Page.
431
432 If you believe you have an unreported bug, please open an issue at
433 L<https://github.com/Perl/perl5/issues>.  Be sure to trim your bug down to a
434 tiny but sufficient test case.
435
436 If the bug you are reporting has security implications which make it
437 inappropriate to send to a public issue tracker, then see
438 L<perlsec/SECURITY VULNERABILITY CONTACT INFORMATION>
439 for details of how to report the issue.
440
441 =head1 Give Thanks
442
443 If you wish to thank the Perl 5 Porters for the work we had done in Perl 5,
444 you can do so by running the C<perlthanks> program:
445
446     perlthanks
447
448 This will send an email to the Perl 5 Porters list with your show of thanks.
449
450 =head1 SEE ALSO
451
452 The F<Changes> file for an explanation of how to view exhaustive details on
453 what changed.
454
455 The F<INSTALL> file for how to build Perl.
456
457 The F<README> file for general stuff.
458
459 The F<Artistic> and F<Copying> files for copyright information.
460
461 =cut