Add perldelta entry for non-destructive substitution
[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 XXX For a release on a stable branch, this section aspires to be:
23
24     There are no changes intentionally incompatible with 5.XXX.XXX. If any
25     exist, they are bugs and reports are welcome.
26
27
28 =head1 Core Enhancements
29
30 XXX New core language features go here. Summarise user-visible core language
31 enhancements. Particularly prominent performance optimisations could go
32 here, but most should go in the L</Performance Enhancements> section.
33
34 =head2 Non-destructive substitution
35
36 The substitution operator now supports a C</r> option that
37 copies the input variable, carries out the substitution on
38 the copy and returns the result.  The original remains unmodified.
39
40   my $old = 'cat';
41   my $new = $old =~ s/cat/dog/r;
42   # $old is 'cat' and $new is 'dog'
43
44 This is particularly useful with C<map>.  See L<perlop> for more examples.
45
46 =head1 New Platforms
47
48 XXX List any platforms that this version of perl compiles on, that previous
49 versions did not. These will either be enabled by new files in the F<hints/>
50 directories, or new subdirectories and F<README> files at the top level of the
51 source tree.
52
53 =head1 Modules and Pragmata
54
55 XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
56 go here.  If Module::CoreList is updated, generate an initial draft of the
57 following sections using F<Porting/corelist-perldelta.pl>, which prints stub
58 entries to STDOUT.  Results can be pasted in place of the '=head2' entries
59 below.  A paragraph summary for important changes should then be added by hand.
60 In an ideal world, dual-life modules would have a F<Changes> file that could be
61 cribbed.
62
63 =head2 New Modules and Pragmata
64
65 =head2 Pragmata Changes
66
67 =head2 Updated Modules
68
69 =head2 Removed Modules and Pragmata
70
71 =head1 Utility Changes
72
73 XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
74 here. Most of these are built within the directories F<utils> and F<x2p>.
75
76 =over 4
77
78 =item F<XXX>
79
80 XXX
81
82 =back
83
84 =head1 New Documentation
85
86 XXX Changes which create B<new> files in F<pod/> go here.
87
88 =over 4
89
90 =item L<XXX>
91
92 XXX
93
94 =back
95
96 =head1 Changes to Existing Documentation
97
98 XXX Changes which significantly change existing files in F<pod/> go here.
99 Any changes to F<pod/perldiag.pod> should go in L</New or Changed Diagnostics>.
100
101
102 =head1 Performance Enhancements
103
104 XXX Changes which enhance performance without changing behaviour go here. There
105 may well be none in a stable release.
106
107 =over 4
108
109 =item *
110
111 XXX
112
113 =back
114
115 =head1 Installation and Configuration Improvements
116
117 XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
118 go here.
119
120 =head2 Configuration improvements
121
122 XXX
123
124 =head2 Compilation improvements
125
126 XXX
127
128 =head2 Platform Specific Changes
129
130 =over 4
131
132 =item XXX-some-platform
133
134 XXX
135
136 =back
137
138 =head1 Selected Bug Fixes
139
140 XXX Important bug fixes in the core language are summarised here.
141 Bug fixes in files in F<ext/> and F<lib/> are best summarised in
142 L</Modules and Pragmata>.
143
144 =over 4
145
146 =item *
147
148 Overloading now works properly in conjunction with tied variables. What
149 formerly happened was that most ops checked their arguments for overloading
150 I<before> checking for magic, so for example an overloaded object returned
151 by a tied array access would usually be treated as not overloaded
152 (RT #57012).
153
154 =back
155
156 =head1 New or Changed Diagnostics
157
158 XXX New or changed warnings emitted by the core's C<C> code go here.
159
160 =over 4
161
162 =item C<XXX>
163
164 XXX
165
166 =back
167
168 =head1 Changed Internals
169
170 XXX Changes which affect the interface available to C<XS> code go here.
171
172 =over 4
173
174 =item *
175
176 The following new functions or macros have been added to the public API:
177 C<SvNV_nomg>,  C<sv_2nv_flags>.
178
179 =back
180
181 =head1 New Tests
182
183 XXX Changes which create B<new> files in F<t/> go here. Changes to
184 existing files in F<t/> aren't worth summarising, although the bugs that
185 they represent may be.
186
187 =over 4
188
189 =item F<XXX>
190
191 XXX
192
193 =back
194
195 =head1 Known Problems
196
197 XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
198 tests that had to be C<TODO>ed for the release would be noted here, unless
199 they were specific to a particular platform (see below).
200
201 This is a list of some significant unfixed bugs, which are regressions
202 from either 5.XXX.XXX or 5.XXX.XXX.
203
204 =over 4
205
206 =item *
207
208 XXX
209
210 =back
211
212 =head1 Deprecations
213
214 XXX Add any new known deprecations here.
215
216 The following items are now deprecated.
217
218 =over 4
219
220 =item *
221
222 XXX
223
224 =back
225
226 =head1 Platform Specific Notes
227
228 XXX Any changes specific to a particular platform. VMS and Win32 are the usual
229 stars here. It's probably best to group changes under the same section layout
230 as the main perldelta
231
232 =head1 Obituary
233
234 XXX If any significant core contributor has died, we've added a short obituary
235 here.
236
237 =head1 Acknowledgements
238
239 XXX The list of people to thank goes here.
240
241
242 =head1 Reporting Bugs
243
244 If you find what you think is a bug, you might check the articles
245 recently posted to the comp.lang.perl.misc newsgroup and the perl
246 bug database at http://rt.perl.org/perlbug/ .  There may also be
247 information at http://www.perl.org/ , the Perl Home Page.
248
249 If you believe you have an unreported bug, please run the B<perlbug>
250 program included with your release.  Be sure to trim your bug down
251 to a tiny but sufficient test case.  Your bug report, along with the
252 output of C<perl -V>, will be sent off to perlbug@perl.org to be
253 analysed by the Perl porting team.
254
255 If the bug you are reporting has security implications, which make it
256 inappropriate to send to a publicly archived mailing list, then please send
257 it to perl5-security-report@perl.org. This points to a closed subscription
258 unarchived mailing list, which includes all the core committers, who be able
259 to help assess the impact of issues, figure out a resolution, and help
260 co-ordinate the release of patches to mitigate or fix the problem across all
261 platforms on which Perl is supported. Please only use this address for
262 security issues in the Perl core, not for modules independently
263 distributed on CPAN.
264
265 =head1 SEE ALSO
266
267 The F<Changes> file for an explanation of how to view exhaustive details
268 on what changed.
269
270 The F<INSTALL> file for how to build Perl.
271
272 The F<README> file for general stuff.
273
274 The F<Artistic> and F<Copying> files for copyright information.
275
276 =cut