add docs for the SV struct changes
[p5sagit/p5-mst-13.2.git] / pod / perl5132delta.pod
1 =encoding utf8
2
3 =head1 NAME
4
5 perldelta - what is new for perl v5.13.2
6
7 =head1 DESCRIPTION
8
9 This document describes differences between the 5.13.2 release and
10 the 5.13.1 release.
11
12 If you are upgrading from an earlier release such as 5.10, first read
13 L<perl5120delta>, which describes differences between 5.10 and
14 5.12.
15
16 =head1 Notice
17
18 XXX Any important notices here
19
20 =head1 Incompatible Changes
21
22 =head2 localised tied scalars are tied again.
23
24 The change in behaviour in 5.13.1 of localising tied scalar values has
25 been reverted to the existing 5.12.0 and earlier behaviour (the change for
26 arrays and hashes remains).
27
28 =head2 Naming fixes in Policy_sh.SH may invalidate Policy.sh
29
30 Several long-standing typos and naming confusions in Policy_sh.SH have
31 been fixed, standardizing on the variable names used in config.sh.
32
33 This will change the behavior of Policy.sh if you happen to have been
34 accidentally relying on the Policy.sh incorrect behavior. We'd appreciate
35 feedback from anyone using Policy.sh to be sure nothing is broken by
36 this change (c1bd23).
37
38 =head1 Core Enhancements
39
40 XXX New core language features go here. Summarise user-visible core language
41 enhancements. Particularly prominent performance optimisations could go
42 here, but most should go in the L</Performance Enhancements> section.
43
44 =head2 Non-destructive substitution
45
46 The substitution operator now supports a C</r> option that
47 copies the input variable, carries out the substitution on
48 the copy and returns the result.  The original remains unmodified.
49
50   my $old = 'cat';
51   my $new = $old =~ s/cat/dog/r;
52   # $old is 'cat' and $new is 'dog'
53
54 This is particularly useful with C<map>.  See L<perlop> for more examples
55 (4f4d75, 000c65).
56
57 =head2 package block syntax
58
59 A package declaration can now contain a code block, in which case the
60 declaration is in scope only inside that block.  So C<package Foo { ... }>
61 is precisely equivalent to C<{ package Foo; ... }>.  It also works with
62 a version number in the declaration, as in C<package Foo 1.2 { ... }>.
63 See L<perlfunc> (434da3..36f77d, 702646).
64
65 =head2 perl -h no longer recommends -w
66
67 perl -h used to mark the -w option as recommended; since this option is
68 far less useful than it used to be due to lexical 'use warnings' and since
69 perl -h is primary a list and brief explanation of the command line switches,
70 the recommendation has now been removed (60eaec).
71
72 =head1 New Platforms
73
74 XXX List any platforms that this version of perl compiles on, that previous
75 versions did not. These will either be enabled by new files in the F<hints/>
76 directories, or new subdirectories and F<README> files at the top level of the
77 source tree.
78
79 =head1 Modules and Pragmata
80
81 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
82 go here.  If Module::CoreList is updated, generate an initial draft of the
83 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
84 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
85 below.  A paragraph summary for important changes should then be added by hand.
86 In an ideal world, dual-life modules would have a F<Changes> file that could be
87 cribbed.
88
89 =head2 New Modules and Pragmata
90
91 =head2 Pragmata Changes
92
93 =head2 Updated Modules
94
95 =head2 Locale-Codes 3.13
96
97 Locale::Country, Locale::Language and Locale::Currency were updated from
98 3.12 to 3.13 of the Locale-Codes distribution to include locale code changes
99 (e1137b).
100
101 =head2 Thread-Semaphore 2.11
102
103 Added new methods ->down_nb() and ->down_force() at the suggestion of Rick
104 Garlick.
105
106 Refactored methods to skip argument validation when no argument is supplied.
107
108 (04febe, f06daa)
109
110 =head2 CPAN.pm 1.94_57
111    
112             * release 1.94_57
113    
114             * bugfix: treat modules correctly that are deprecated in perl 5.12.
115    
116             * bugfix: RT #57482 and #57788 revealed that configure_requires
117             implicitly assumed build_requires instead of normal requires. (Reported
118             by Andrew Whatson and Father Chrysostomos respectively)
119    
120             * testfix: solaris should run the tests without expect because (some?)
121             solaris have a broken expect
122    
123             * testfix: run tests with cache_metadata off to prevent spill over
124             effects from previous test runs
125
126 (742adb)
127
128 =head2 Removed Modules and Pragmata
129
130 =head1 Utility Changes
131
132 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
133 here. Most of these are built within the directories F<utils> and F<x2p>.
134
135 =over 4
136
137 =item F<XXX>
138
139 XXX
140
141 =back
142
143 =head1 New Documentation
144
145 XXX Changes which create B<new> files in F<pod/> go here.
146
147 =over 4
148
149 =item L<XXX>
150
151 XXX
152
153 =back
154
155 =head1 Changes to Existing Documentation
156
157 XXX Changes which significantly change existing files in F<pod/> go here.
158 Any changes to F<pod/perldiag.pod> should go in L</New or Changed Diagnostics>.
159
160 =head2 Replace wrong tr/// table in perlebcdic.pod
161
162 perlebcdic.pod contains a helpful table to use in tr/// to convert
163 between EBCDIC and Latin1/ASCII.  Unfortunately, the table was the
164 inverse of the one it describes, though the code that used the table
165 worked correctly for the specific example given.
166
167 The table has been changed to its inverse, and the sample code changed
168 to correspond, as this is easier for the person trying to follow the
169 instructions since deriving the old table is somewhat more complicated.
170
171 The table has also been changed to hex from octal, as that is more the norm
172 these days, and the recipes in the pod altered to print out leading
173 zeros to make all the values the same length, as the table that they can
174 generate has them (5f26d5).
175
176 =head2 Document tricks for user-defined casing
177
178 perlunicode.pod now contains an explanation of how to override, mangle
179 and otherwise tweak the way perl handles upper, lower and other case
180 conversions on unicode data, and how to provide scoped changes to alter
181 one's own code's behaviour without stomping on anybody else (71648f).
182
183 =head2 Document $# and $* as removed and clarify $#array usage
184
185 $# and $* were both disabled as of perl5 version 10; this release adds
186 documentation to that effect, a description of the results of continuing
187 to try and use them, and a note explaining that $# can also function as a
188 sigil in the $#array form (7f315d2).
189
190 =head2 INSTALL explicitly states the requirement for C89
191
192 This was already true but it's now Officially Stated For The Record (51eec7).
193
194 =head2 No longer advertise Math::TrulyRandom
195
196 This module hasn't been updated since 1996 so we can't recommend it any more
197 (83918a).
198
199 =head1 Performance Enhancements
200
201 Only allocate entries for @_ on demand - this not only saves memory per
202 subroutine defined but should hopefully improve COW behaviour (77bac2).
203
204 =head2 Multiple small improvements to threads
205
206 The internal structures of threading now make fewer API calls and fewer
207 allocations, resulting in noticeably smaller object code. Additionally,
208 many thread context checks have been deferred so that they're only done
209 when required (although this is only possible for non-debugging builds).
210
211 =head2 Size optimisations to SV and HV structures
212
213 xhv_fill has been eliminated from struct xpvhv, saving 1 IV per hash and
214 on some systems will cause struct xpvhv to become cache aligned. To avoid
215 this memory saving causing a slowdown elsewhere, boolean use of HvFILL
216 now calls HvTOTALKEYS instead (which is equivalent) - so while the fill
217 data when actually required is now calculated on demand, the cases when
218 this needs to be done should be few and far between (f4431c .. fcd245).
219
220 The order of structure elements in SV bodies has changed. Effectively,
221 the NV slot has swapped location with STASH and MAGIC. As all access to
222 SV members is via macros, this should be completely transparent. This
223 change allows the space saving for PVHVs documented above, and may reduce
224 the memory allocation needed for PVIVs on some architectures.
225
226 =head2 Optimisation of regexp engine string comparison work
227
228 The foldEQ_utf8 API function for case-insensitive comparison of strings (which
229 is used heavily by the regexp engine) was substantially refactored and
230 optimised - and its documentation much improved as a free bonus gift
231 (8b3587, e6226b).
232
233 =head2 
234
235 =head2 
236
237 =head1 Installation and Configuration Improvements
238
239 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
240 go here.
241
242 =head2 Configuration improvements
243
244 XXX
245
246 =head2 Compilation improvements
247
248 Fix CCINCDIR and CCLIBDIR for mingw64 cross compiler to correctly be under
249 $(CCHOME)\mingw\include and \lib rather than immediately below $(CCHOME).
250
251 This means the 'incpath', 'libpth', 'ldflags', 'lddlflags' and
252 'ldflags_nolargefiles' values in Config.pm and Config_heavy.pl are now
253 set correctly (23ae7f).
254
255 =head2 Platform Specific Changes
256
257 =over 4
258
259 =item XXX-some-platform
260
261 XXX
262
263 =back
264
265 =head1 Selected Bug Fixes
266
267 Timely cleanup of SVs that are cloned into a new thread but then discovered
268 to be orphaned (i.e. their owners are -not- cloned) (e42956)
269
270 Don't accidentally clone lexicals in scope within active stack frames in
271 the parent when creating a child thread (RT #73086) (05d04d).
272
273 Avoid loading feature.pm when 'no 5.13.2;' or similar is encountered (faee19).
274
275 Trap invalid use of SvIVX on SVt_REGEXP when assertions are on (e77da3)
276
277 Don't stamp on $DB::single, $DB::trace and $DB::signal if they already have
278 values when $^P is assigned to (RT #72422) (4c0f30).
279
280 chop now correctly handles perl's extended UTF-8 (RT #73246) (65ab92)
281
282 Defer signal handling when shared SV locks are held to avoid deadlocks
283 (RT #74868) (65c742).
284
285 glob() no longer crashes when %File::Glob:: is empty and CORE::GLOBAL::glob
286 isn't present (4984aa).
287
288 perlbug now always permits the sender address to be changed before sending
289 - if you were having trouble sending bug reports before now, this should
290 fix it, we hope (e6eb90).
291
292 =over 4
293
294 =item *
295
296 Overloading now works properly in conjunction with tied variables. What
297 formerly happened was that most ops checked their arguments for overloading
298 I<before> checking for magic, so for example an overloaded object returned
299 by a tied array access would usually be treated as not overloaded
300 (RT #57012) (6f1401, ed3b9b, 6a5f8c .. 24328f).
301
302 =back
303
304 Independently, a bug was fixed that prevented $tied->() from always calling
305 FETCH correctly (RT #8438) (7c7501)
306
307 =head1 New or Changed Diagnostics
308
309 XXX New or changed warnings emitted by the core's C<C> code go here.
310
311 =over 4
312
313 =item C<XXX>
314
315 XXX
316
317 =back
318
319 =head1 Changed Internals
320
321 XXX Changes which affect the interface available to C<XS> code go here.
322
323 =over 4
324
325 =item *
326
327 The C<find_rundefsvoffset> function has been deprecated. It appeared that
328 its design was insufficient to reliably get the lexical C<$_> at run-time.
329
330 Use the new C<find_rundefsv> function or the C<UNDERBAR> macro instead.
331 They directly return the right SV representing C<$_>, whether it's lexical
332 or dynamic (789bd8 .. 03d5bc).
333
334 =item *
335
336 The following new functions or macros have been added to the public API:
337 C<SvNV_nomg>,  C<sv_2nv_flags>, C<find_rundefsv>.
338
339 =item *
340
341 The C<UNDERBAR> macro now calls C<find_rundefsv>. C<dUNDERBAR> is now a
342 noop but should still be used to ensure past and future compatibility.
343
344 =item *
345
346 The ibcmp_* functions have been renamed and are now called foldEQ,
347 foldEQ_locale and foldEQ_utf8 (e6226b).
348
349 =item *
350
351 The ibcmp_* functions have been renamed and are now called foldEQ,
352 foldEQ_locale and foldEQ_utf8 (e6226b).
353
354 =back
355
356 =head1 New Tests
357
358 XXX Changes which create B<new> files in F<t/> go here. Changes to
359 existing files in F<t/> aren't worth summarising, although the bugs that
360 they represent may be.
361
362 =over 4
363
364 =item F<XXX>
365
366 XXX
367
368 =back
369
370 =head1 Known Problems
371
372 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
373 tests that had to be C<TODO>ed for the release would be noted here, unless
374 they were specific to a particular platform (see below).
375
376 This is a list of some significant unfixed bugs, which are regressions
377 from either 5.XXX.XXX or 5.XXX.XXX.
378
379 =over 4
380
381 =item *
382
383 XXX
384
385 =back
386
387 =head1 Deprecations
388
389 XXX Add any new known deprecations here.
390
391 The following items are now deprecated.
392
393 =over 4
394
395 =item *
396
397 Omitting a space between a regex pattern or pattern modifiers and the following
398 word is deprecated.  For example, C<< m/foo/sand $bar >> will still be parsed
399 as C<< m/foo/s and $bar >> but will issue a warning.
400
401 =back
402
403 =head1 Platform Specific Notes
404
405 =head2 Recent OpenBSDs now use perl's malloc
406
407 OpenBSD > 3.7 has a new malloc implementation which is mmap based and as such
408 can release memory back to the OS; however for perl using this malloc causes
409 a substantial slowdown so we now default to using perl's malloc instead
410 (RT #75742) (9b58b5).
411
412 =head1 Obituary
413
414 XXX If any significant core contributor has died, we've added a short obituary
415 here.
416
417 =head1 Acknowledgements
418
419 XXX The list of people to thank goes here.
420
421 Your humble release manager would like to specifically call out
422 Karl Williamson for making the tests a better place to be, and Shlomi
423 Fish for a passel of tiny incremental docfixes of the sort that don't get
424 made often enough.
425
426 =head1 Reporting Bugs
427
428 If you find what you think is a bug, you might check the articles
429 recently posted to the comp.lang.perl.misc newsgroup and the perl
430 bug database at http://rt.perl.org/perlbug/ .  There may also be
431 information at http://www.perl.org/ , the Perl Home Page.
432
433 If you believe you have an unreported bug, please run the B<perlbug>
434 program included with your release.  Be sure to trim your bug down
435 to a tiny but sufficient test case.  Your bug report, along with the
436 output of C<perl -V>, will be sent off to perlbug@perl.org to be
437 analysed by the Perl porting team.
438
439 If the bug you are reporting has security implications, which make it
440 inappropriate to send to a publicly archived mailing list, then please send
441 it to perl5-security-report@perl.org. This points to a closed subscription
442 unarchived mailing list, which includes all the core committers, who be able
443 to help assess the impact of issues, figure out a resolution, and help
444 co-ordinate the release of patches to mitigate or fix the problem across all
445 platforms on which Perl is supported. Please only use this address for
446 security issues in the Perl core, not for modules independently
447 distributed on CPAN.
448
449 =head1 SEE ALSO
450
451 The F<Changes> file for an explanation of how to view exhaustive details
452 on what changed.
453
454 The F<INSTALL> file for how to build Perl.
455
456 The F<README> file for general stuff.
457
458 The F<Artistic> and F<Copying> files for copyright information.
459
460 =cut