charnames.pm: Nits in pod

[perl5.git] / pod / perldelta.pod

=encoding utf8

=head1 NAME

[ this is a template for a new perldelta file. Any text flagged as
XXX needs to be processed before release. ]

perldelta - what is new for perl v5.13.6

=head1 DESCRIPTION

This document describes differences between the 5.13.5 release and
the 5.13.6 release.

If you are upgrading from an earlier release such as 5.13.4, first read
L<perl5135delta>, which describes differences between 5.13.4 and
5.13.5.

=head1 Notice

XXX Any important notices here

=head1 Core Enhancements

XXX New core language features go here. Summarise user-visible core language
enhancements. Particularly prominent performance optimisations could go
here, but most should go in the L</Performance Enhancements> section.

[ List each enhancement as a =head2 entry ]

=head2  C<(?^...)> regex construct added to signify default modifiers

A caret (also called a "cirumflex accent") C<"^"> immediately following
a C<"(?"> in a regular expression now means that the subexpression is to
not inherit the surrounding modifiers such as C</i>, but to revert to the
Perl defaults.  Any modifiers following the caret override the defaults.

The stringification of regular expressions now uses this notation.  The
main purpose of this is to allow tests that rely on the stringification
to not have to change when new modifiers are added.  See
L<perlre/Extended Patterns>.

=head2 C<"d">, C<"l">, and C<"u"> regex modifiers added

These modifiers are currently only available within a C<(?...)> construct.

The C<"l"> modifier says to compile the regular expression as if it were
in the scope of C<use locale>, even if it is not.

The C<"u"> modifier currently does nothing.

The C<"d"> modifier is used in the scope of C<use locale> to compile the
regular expression as if it were not in that scope.
See L<perlre/(?dlupimsx-imsx)>.

=head1 Security

XXX Any security-related notices go here.  In particular, any security
vulnerabilities closed should be noted here rather than in the
L</Selected Bug Fixes> section.

[ List each security issue as a =head2 entry ]

=head1 Incompatible Changes

=head2 Stringification of regexes has changed

Default regular expression modifiers are now notated by using
C<(?^...)>.  Code relying on the old stringification will fail.  The
purpose of this is so that when new modifiers are added, such code will
not have to change (after this one time), as the stringification will
automatically incorporate the new modifiers.

Code that needs to work properly with both old- and new-style regexes
can avoid the whole issue by using (for Perls since 5.9.5):

 use re qw(regexp_pattern);
 my ($pat, $mods) = regexp_pattern($re_ref);

where C<$re_ref> is a reference to a compiled regular expression.  Upon
return, C<$mods> will be a string containing all the non-default
modifiers used when the regular expression was compiled, and C<$pattern>
the actual pattern.

If the actual stringification is important, or older Perls need to be
supported, you can use something like the following:

    # Accept both old and new-style stringification
    my $modifiers = (qr/foobar/ =~ /\Q(?^/) ? '^' : '-xism';

And then use C<$modifiers> instead of C<-xism>.

=head2 Regular expressions retain their localeness when interpolated

Regular expressions compiled under C<"use locale"> now retain this when
interpolated into a new regular expression compiled outside a
C<"use locale">, and vice-versa.

Previously, a regular expression interpolated into another one inherited
the localeness of the surrounding one, losing whatever state it
originally had.  This is considered a bug fix, but may trip up code that
has come to rely on the incorrect behavior.

[ List each incompatible change as a =head2 entry ]

=head1 Deprecations

XXX Any deprecated features, syntax, modules etc. should be listed here.
In particular, deprecated modules should be listed here even if they are
listed as an updated module in the L</Modules and Pragmata> section.

[ List each deprecation as a =head2 entry ]

=head1 Performance Enhancements

XXX Changes which enhance performance without changing behaviour go here. There
may well be none in a stable release.

[ List each enhancement as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Modules and Pragmata

XXX All changes to installed files in F<cpan/>, F<dist/>, F<ext/> and F<lib/>
go here.  If Module::CoreList is updated, generate an initial draft of the
following sections using F<Porting/corelist-perldelta.pl>, which prints stub
entries to STDOUT.  Results can be pasted in place of the '=head2' entries
below.  A paragraph summary for important changes should then be added by hand.
In an ideal world, dual-life modules would have a F<Changes> file that could be
cribbed.

[ Within each section, list entries as a =item entry ]

=head2 New Modules and Pragmata

=over 4

=item *

XXX

=back

=head2 Updated Modules and Pragmata

=over 4

=item *

C<File::DosGlob> has been upgraded from version 1.02 to 1.03.

It allows patterns containing literal parentheses (they no longer need to
be escaped). On Windows, it no longer adds an extra F<./> to the file names
returned when the pattern is a relative glob with a drive specification,
like F<c:*.pl>
L<[perl #71712]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71712>.

=item *

C<File::Find> has been upgraded from version 1.17 to 1.18.

It improves handling of backslashes on Windows, so that paths such as
F<c:\dir\/file> are no longer generated
L<[perl #71710]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71710>.

=item *

C<NEXT> has been upgraded from version 0.64 to 0.65.

=item *

C<PathTools> has been upgraded from version 3.31_01 to 3.33.

=item *

C<sigtrap> has been upgraded from version 1.04 to 1.05.

It no longer tries to modify read-only arguments when generating a
backtrace
L<[perl #72340]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=72340>.

=item *

C<Unicode::Collate> has been upgraded from version 0.59 to 0.60

=item *

C<Unicode::Normalize> has been upgraded from version 1.06 to 1.07

=back

=head2 Removed Modules and Pragmata

=over 4

=item *

XXX

=back

=head1 Documentation

XXX Changes to files in F<pod/> go here.  Consider grouping entries by
file and be sure to link to the appropriate page, e.g. L<perlfunc>.

=head2 New Documentation

XXX Changes which create B<new> files in F<pod/> go here.

=head3 L<XXX>

XXX Description of the purpose of the new file here

=head2 Changes to Existing Documentation

XXX Changes which significantly change existing files in F<pod/> go here.
However, any changes to F<pod/perldiag.pod> should go in the L</Diagnostics>
section.

=head3 L<XXX>

=over 4

=item *

The documentation for the C<SvTRUE> macro was simply wrong in stating that
get-magic is not processed. It has been corrected.

=back

=head1 Diagnostics

The following additions or changes have been made to diagnostic output,
including warnings and fatal error messages.  For the complete list of
diagnostic messages, see L<perldiag>.

XXX New or changed warnings emitted by the core's C<C> code go here. Also
include any changes in L<perldiag> that reconcile it to the C<C> code.

[ Within each section, list entries as a =item entry ]

=head2 New Diagnostics

XXX Newly added diagnostic messages go here

=over 4

=item *

XXX

=back

=head2 Changes to Existing Diagnostics

XXX Changes (i.e. rewording) of diagnostic messages go here

=over 4

=item *

XXX

=back

=head1 Utility Changes

XXX Changes to installed programs such as F<perlbug> and F<xsubpp> go
here. Most of these are built within the directories F<utils> and F<x2p>.

[ List utility changes as a =head3 entry for each utility and =item
entries for each change
Use L<XXX> with program names to get proper documentation linking. ]

=head3 L<XXX>

=over 4

=item *

XXX

=back

=head1 Configuration and Compilation

XXX Changes to F<Configure>, F<installperl>, F<installman>, and analogous tools
go here.  Any other changes to the Perl build process should be listed here.
However, any platform-specific changes should be listed in the
L</Platform Support> section, instead.

[ List changes as a =item entry ].

=over 4

=item *

XXX

=back

=head1 Testing

XXX Any significant changes to the testing of a freshly built perl should be
listed here.  Changes which create B<new> files in F<t/> go here as do any
large changes to the testing harness (e.g. when parallel testing was added).
Changes to existing files in F<t/> aren't worth summarising, although the bugs
that they represent may be covered elsewhere.

[ List each test improvement as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Platform Support

XXX Any changes to platform support should be listed in the sections below.

[ Within the sections, list each platform as a =item entry with specific
changes as paragraphs below it. ]

=head2 New Platforms

XXX List any platforms that this version of perl compiles on, that previous
versions did not. These will either be enabled by new files in the F<hints/>
directories, or new subdirectories and F<README> files at the top level of the
source tree.

=over 4

=item XXX-some-platform

XXX

=back

=head2 Discontinued Platforms

XXX List any platforms that this version of perl no longer compiles on.

=over 4

=item XXX-some-platform

XXX

=back

=head2 Platform-Specific Notes

XXX List any changes for specific platforms. This could include configuration
and compilation changes or changes in portability/compatibility.  However,
changes within modules for platforms should generally be listed in the
L</Modules and Pragmata> section.

=over 4

=item XXX-some-platform

XXX

=back

=head1 Internal Changes

XXX Changes which affect the interface available to C<XS> code go here.
Other significant internal changes for future core maintainers should
be noted as well.

[ List each test improvement as a =item entry ]

=over 4

=item *

See L</Regular expressions retain their localeness when interpolated>,
above.

=item *

The C<sv_cmp_flags>, C<sv_cmp_locale_flags>, C<sv_eq_flags> and
C<sv_collxfrm_flags> functions have been added. These are like their
non-_flags counterparts, but allow one to specify whether get-magic is
processed.

The C<sv_cmp>, C<sv_cmp_locale>, C<sv_eq> and C<sv_collxfrm> functions have
been replaced with wrappers around the new functions. 

=item *

A new C<sv_2bool_flags> function has been added.

This is like C<sv_2bool>, but it lets the calling code decide whether
get-magic is handled. C<sv_2bool> is now a macro that calls the new
function.

=item *

A new macro, C<SvTRUE_nomg>, has been added.

This is like C<SvTRUE>, except that it does not process magic. It uses the
new C<sv_2bool_flags> function.

=item *

C<sv_catsv_flags> no longer calls C<mg_get> on its second argument (the
source string) if the flags passed to it do not include SV_GMAGIC. So it
now matches what the documentation says it does.

=back

=head1 Selected Bug Fixes

XXX Important bug fixes in the core language are summarised here.
Bug fixes in files in F<ext/> and F<lib/> are best summarised in
L</Modules and Pragmata>.

[ List each fix as a =item entry ]

=over 4

=item *

A regular expression match in the right-hand side of a global substitution
(C<s///g>) that is in the same scope will no longer cause match variables
to have the wrong values on subsequent iterations. This can happen when an
array or hash subscript is interpolated in the right-hand side, as in
C<s|(.)|@a{ print($1), /./ }|g>
L<[perl #19078]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=19078>.

=item *

Constant-folding used to cause

  $text =~ ( 1 ? /phoo/ : /bear/)

to turn into

  $text =~ /phoo/

at compile time. Now it correctly matches against C<$_>
L<[perl #20444]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=20444>.

=item *

Parsing Perl code (either with string C<eval> or by loading modules) from
within a C<UNITCHECK> block no longer causes the interpreter to crash
L<[perl #70614]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=70614>.

=item *

When C<-d> is used on the shebang (C<#!>) line, the debugger now has access
to the lines of the main program. In the past, this sometimes worked and
sometimes did not, depending on what order things happened to be arranged
in memory
L<[perl #71806]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=71806>.

=item *

The C<y///> or C<tr///> operator now calls get-magic (e.g., the C<FETCH>
method of a tie) on its left-hand side just once, not twice
L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.

=item *

String comparison (C<eq>, C<ne>, C<lt>, C<gt>, C<le>, C<ge> and
C<cmp>) and logical not (C<not> and C<!>) operators no longer call magic
(e.g., tie methods) twice on their operands
L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.

This bug was introduced in an earlier 5.13 release, and does not affect
perl 5.12.

=item *

When a tied (or other magic) variable is used as, or in, a regular
expression, it no longer has its C<FETCH> method called twice
L<[perl #76814]|http://rt.perl.org/rt3//Public/Bug/Display.html?id=76814>.

This bug was introduced in an earlier 5.13 release, and does not affect
perl 5.12.

=back

=head1 Known Problems

XXX Descriptions of platform agnostic bugs we know we can't fix go here. Any
tests that had to be C<TODO>ed for the release would be noted here, unless
they were specific to a particular platform (see below).

This is a list of some significant unfixed bugs, which are regressions
from either 5.XXX.XXX or 5.XXX.XXX.

[ List each fix as a =item entry ]

=over 4

=item *

XXX

=back

=head1 Obituary

XXX If any significant core contributor has died, we've added a short obituary
here.

=head1 Errata

=over 4

=item *

Fixed a typo in L<perl5135delta> regarding array slices and smart matching

=back

=head1 Acknowledgements

XXX The list of people to thank goes here.

=head1 Reporting Bugs

If you find what you think is a bug, you might check the articles
recently posted to the comp.lang.perl.misc newsgroup and the perl
bug database at http://rt.perl.org/perlbug/ .  There may also be
information at http://www.perl.org/ , the Perl Home Page.

If you believe you have an unreported bug, please run the B<perlbug>
program included with your release.  Be sure to trim your bug down
to a tiny but sufficient test case.  Your bug report, along with the
output of C<perl -V>, will be sent off to perlbug@perl.org to be
analysed by the Perl porting team.

If the bug you are reporting has security implications, which make it
inappropriate to send to a publicly archived mailing list, then please send
it to perl5-security-report@perl.org. This points to a closed subscription
unarchived mailing list, which includes all the core committers, who be able
to help assess the impact of issues, figure out a resolution, and help
co-ordinate the release of patches to mitigate or fix the problem across all
platforms on which Perl is supported. Please only use this address for
security issues in the Perl core, not for modules independently
distributed on CPAN.

=head1 SEE ALSO

The F<Changes> file for an explanation of how to view exhaustive details
on what changed.

The F<INSTALL> file for how to build Perl.

The F<README> file for general stuff.

The F<Artistic> and F<Copying> files for copyright information.

=cut