This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
perldelta for #112966/2c5f48c251e
[perl5.git] / pod / perldelta.pod
index b512c98..f275297 100644 (file)
 =encoding utf8
 
-=for todo
-5204593b74eb sv.c: Make sv_pvn_force_flags guard against SV_UNDEF_RETURNS_NULL.
-28333232a1c7 Don’t localise CopSTASH(&PL_compiling) in newCONSTSUB
-c947b31cf142 Do away with stashpv_hvname_match
-d0279c7ce493 Fix bad assertions in pp_ctl.c:pp_caller
-1db94eebfa93 Quieten B::Deparse warnings (fixes #113464).
-9a62b98f29d2 gv.c: Don’t ENTER/LEAVE unnecessarily
-ee1b3814fd18 gv.c: Remove mro_method_changed_in() from gv_init
-a3c74922a705 Rmv mro_method_changed_in call on stub upgraded to const
-7ad40bcb0a19 Don’t call mro_method_changed_in after newCONSTSUB
-
 =head1 NAME
 
-perldelta - what is new for perl v5.17.1
-
-=head1 DESCRIPTION
-
-This document describes differences between the 5.17.0 release and
-the 5.17.1 release.
+[ this is a template for a new perldelta file. Any text flagged as
+XXX needs to be processed before release. ]
 
-If you are upgrading from an earlier release such as 5.16.0, first read
-L<perl5170delta>, which describes differences between 5.16.0 and
-5.17.0.
+perldelta - what is new for perl v5.17.2
 
-=head1 Core Enhancements
+=head1 DESCRIPTION
 
-=head2 More CORE:: subs
+This document describes differences between the 5.17.1 release and
+the 5.17.2 release.
 
-Several more built-in functions have been added as subroutines to the
-CORE:: namespace, namely, those non-overridable keywords that can be
-implemented without custom parsers: C<defined>, C<delete>, C<exists>,
-C<glob>, C<pos>, C<protoytpe>, C<scalar>, C<split>, C<study>, and C<undef>.
+If you are upgrading from an earlier release such as 5.17.0, first read
+L<perl5171delta>, which describes differences between 5.17.0 and
+5.17.1.
 
-As some of these have prototypes, C<prototype('CORE::...')> has been
-changed to not make a distinction between overridable and non-overridable
-keywords.  This is to make C<prototype('CORE::pos')> consistent with
-C<prototype(&CORE::pos)>.
+=head1 Notice
 
-=head1 Incompatible Changes
+XXX Any important notices here
 
-=head2 C</(?{})/> and C</(??{}> have been heavily reworked.
-
-The implementation of this feature has been almost completely rewritten.
-Although its main intent is to fix bugs, some behaviours, especially
-related to the scope of lexical variables, will have changed.  This is
-described more fully in the L</Selected Bug Fixes> section.
+=head1 Core Enhancements
 
-=head2 C<\N{BELL}> now refers to U+1F514 instead of U+0007
+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.
 
-Unicode 6.0 reused the name "BELL" for a different code point than it
-traditionally had meant.  Since Perl v5.14, use of this name still
-referred to U+0007, but would raise a deprecated warning.  Now, "BELL"
-refers to U+1F514, and the name for U+0007 is "ALERT".  All the
-functions in L<charnames> have been correspondingly updated.
+[ List each enhancement as a =head2 entry ]
 
-=head2 Alphanumeric operators must now be separated from the closing
-delimiter of regular expressions
+=head1 Security
 
-You may no longer write something like:
+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.
 
- m/a/and 1
+[ List each security issue as a =head2 entry ]
 
-Instead you must write
+=head1 Incompatible Changes
 
- m/a/ and 1
+XXX For a release on a stable branch, this section aspires to be:
 
-with whitespace separating the operator from the closing delimiter of
-the regular expression.  Not having whitespace has resulted in a
-deprecated warning since Perl v5.14.0.
+    There are no changes intentionally incompatible with 5.XXX.XXX
+    If any exist, they are bugs, and we request that you submit a
+    report.  See L</Reporting Bugs> below.
 
-=head2 C<require> dies for unreadable files
+[ List each incompatible change as a =head2 entry ]
 
-When C<require> encounters an unreadable file, it now dies.  It used to
-ignore the file and continue searching the directories in @INC
-[perl #113422].
+=head1 Deprecations
 
-=head2 Upgrade to the Unicode 6.2 beta
+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.
 
-Unicode 6.2 is proposing some changes that may very well break some CPAN
-modules.  The timing of this nicely coincides with Perl's being early in the
-release cycle.  This commit takes the current beta 6.2, adds the proposed
-changes that aren't yet in it, and subtracts the changes that would affect \X
-processing, as those turn out to have errors, and may have to be rethought.
-Unicode has been notified of these problems.
+[ List each deprecation as a =head2 entry ]
 
-This will allow us to gather data as to whether or not the proposed changes
-cause us problems.  These will be presented to Unicode to aid in their final
-decision as to whether or not to go forward with the changes.
+=head1 Performance Enhancements
 
-These changes will be replaced by the final version of Unicode 6.2 before
-5.18.0 is released.
+XXX Changes which enhance performance without changing behaviour go here. There
+may well be none in a stable release.
 
-=head1 Performance Enhancements
+[ List each enhancement as a =item entry ]
 
 =over 4
 
 =item *
 
-The C<x> repetition operator is now folded to a single constant at compile
-time if called in scalar context with constant operands and no parentheses
-around the left operand.
+XXX
 
 =back
 
 =head1 Modules and Pragmata
 
-=head2 Updated Modules and Pragmata
-
-=over 4
+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.
 
-=item *
+[ Within each section, list entries as a =item entry ]
 
-L<ExtUtils::CBuilder> has been upgraded from version 0.280206 to 0.280208.
+=head2 New Modules and Pragmata
 
-Manifest files are now correctly embedded for those versions of VC++ which
-make use of them. [perl #111782, #111798].
+=over 4
 
 =item *
 
-L<B> has been upgraded from version 1.35 to 1.36.
+XXX
 
-C<B::COP::stashlen> has been replaced with C<B::COP::stashoff>.
+=back
 
-C<B::COP::stashpv> now supports UTF8 package names and embedded NULs.
+=head2 Updated Modules and Pragmata
+
+=over 4
 
 =item *
 
-L<Class::Struct> has been upgraded from version 0.63 to 0.64.
+L<File::stat> has been upgraded from version 1.06 to 1.07.
 
-The constructor now respects overridden accessor methods [perl #29230].
+Previously C<File::stat>'s overloaded C<-x> and C<-X> operators did not give
+the correct results for directories or executable files when running as
+root. They had been treating executable permissions for root just like for
+any other user, performing group membership tests I<etc> for files not owned
+by root. They now follow the correct Unix behaviour - for a directory they
+are always true, and for a file if any of the three execute permission bits
+are set then they report that root can execute the file. Perl's builtin
+C<-x> and C<-X> operators have always been correct.
 
 =item *
 
-L<DynaLoader> has been upgraded from version 1.14 to 1.15.
+L<Tie::StdHandle> has been upgraded from version 4.2 to 4.3.
 
-This is due to a minor code change in the XS for the VMS implementation.
+C<READ> now respects the offset argument to C<read> [perl #112826].
 
-=item *
+=back
 
-L<File::DosGlob> has been upgraded from version 1.07 to 1.08.
+=head2 Removed Modules and Pragmata
 
-There are no visible changes, only minor internal refactorings.
+=over 4
 
 =item *
 
-L<File::Spec::Unix> has been upgraded from version 3.39_02 to 3.39_03.
+XXX
 
-C<abs2rel> could produce incorrect results when given two relative paths or
-the root directory twice [perl #111510].
+=back
 
-=item *
+=head1 Documentation
 
-L<IO> has been upgraded from version 1.25_06 to 1.25_07.
+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>.
 
-C<sync()> can now be called on read-only file handles [perl #64772].
+=head2 New Documentation
 
-=item *
+XXX Changes which create B<new> files in F<pod/> go here.
 
-L<Pod::Html> has been upgraded from version 1.15_02 to 1.16.
+=head3 L<XXX>
 
-The option C<--libpods> has been reinstated. It is deprecated, and its use
-does nothing other than issue a warning that it is no longer supported.
+XXX Description of the purpose of the new file here
 
-Since the HTML files generated by pod2html claim to have a utf-8 charset,
-actually write the files out using utf-8 [perl #111446].
+=head2 Changes to Existing Documentation
 
-=item *
+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.
 
-L<Unicode::UCD> has been upgraded from version 0.43 to 0.44.
+=head3 L<XXX>
 
-This adds a function L<all_casefolds()|Unicode::UCD/all_casefolds()>
-that returns all the casefolds.
+=over 4
 
 =item *
 
-L<Scalar::Util> has been upgraded from version 1.23 to version 1.25.
+XXX Description of the change here
 
 =back
 
-=head1 Documentation
+=head1 Diagnostics
 
-=head2 Changes to Existing Documentation
+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>.
 
-=head3 L<perlfaq>
+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.
 
-=over 4
+[ Within each section, list entries as a =item entry that links to perldiag,
+  e.g.
 
-=item *
+  =item *
 
-L<perlfaq> has been synchronised with version 5.0150040 from C<CPAN>.
+  L<Invalid version object|perldiag/"Invalid version object">
+]
 
-=back
+=head2 New Diagnostics
+
+XXX Newly added diagnostic messages go here
 
-=head3 L<perlcheat>
+=head3 New Errors
 
 =over 4
 
 =item *
 
-L<perlcheat> has been reorganized, and a few new sections were added.
+L<Group name must start with a non-digit word character in regex; marked by <-- HERE in m/%s/|perldiag/"Group name must start with a non-digit word character in regex; marked by <-- HERE in m/%s/">
 
-=back
+This error has been added for C<(?&0)>, which is invalid.  It used to
+produce an incomprehensible error message [perl #101666].
 
-=head1 Diagnostics
+=back
 
-=head2 Removals of Diagnostics
+=head3 New Warnings
 
 =over 4
 
 =item *
 
-The "Runaway prototype" warning that occurs in bizarre cases has been
-removed as being unhelpful and inconsistent.
+C<chr()> now warns when passed a negative value [perl #83048].
 
 =item *
 
-The "Not a format reference" error has been removed, as the only case in
-which it could be triggered was a bug.
-
-=item *
-
-The "Unable to create sub named %s" error has been removed for the same
-reason.
+C<srand()> now warns when passed a value that doesn't fit in a C<UV> (since the
+value will be truncated rather than overflowing) [perl #40605].
 
 =back
 
-=head1 Platform Support
+=head2 Changes to Existing Diagnostics
 
-=head2 Platform-Specific Notes
-
-XXX note fails on win2k and vms
+XXX Changes (i.e. rewording) of diagnostic messages go here
 
 =over 4
 
-=item Win32
-
-C<link> on Win32 now attempts to set C<$!> to more appropriate values
-based on the Win32 API error code. [perl #112272]
+=item *
 
-Perl no longer mangles the environment block, e.g. when launching a new
-sub-process, when the environment contains non-ASCII characters. Known
-problems still remain, however, when the environment contains characters
-outside of the current ANSI codepage (e.g. see the item about Unicode in
-C<%ENV> in L<http://perl5.git.perl.org/perl.git/blob/HEAD:/Porting/todo.pod>).
-[perl #113536]
+XXX Describe change here
 
 =back
 
-=head1 Internal Changes
+=head1 Utility Changes
 
-=over 4
+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>.
 
-=item *
+[ 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. ]
 
-The C<study> function was made a no-op in 5.16.  It was simply disabled via
-a C<return> statement; the code was left in place.  Now the code supporting
-what C<study> used to do has been removed.
+=head3 L<XXX>
 
-=item *
-
-Under threaded perls, there is no longer a separate PV allocated for every
-COP to store its package name (C<< cop->stashpv >>).  Instead, there is an
-offset (C<< cop->stashoff >>) into the new C<PL_stashpad> array, which
-holds stash pointers.
+=over 4
 
 =item *
 
-In the pluggable regex API, the C<regexp_engine> struct has acquired a new
-field C<op_comp>, which is currently just for perl's internal use, and
-should be initialised to NULL by other regex plugin modules.
+XXX
 
-=item *
+=back
 
-A new function C<alloccoptash> has been added to the API, but is considered
-experimental.  See L<perlapi>.
+=head1 Configuration and Compilation
 
-=back
+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.
 
-=head1 Selected Bug Fixes
+[ List changes as a =item entry ].
 
 =over 4
 
 =item *
 
-The implementation of code blocks in regular expressions, such as C<(?{})>
-and C<(??{})> has been heavily reworked to eliminate a whole slew of bugs.
-The main user-visible changes are:
-
-=over 4
+Building perl with some Windows compilers used to fail due to a problem
+with miniperl's C<glob> operator (which uses the C<perlglob> program)
+deleting the PATH environment variable [perl #113798].
 
 =item *
 
-Code blocks within patterns are now parsed in the same pass as the
-surrounding code; in particular it is no longer necessary to have balanced
-braces: this now works:
+C<delete local> no longer crashes with certain magical arrays and hashes
+[perl #112966].
 
-    /(?{  $x='{'  })/
+=item *
 
-This means that this error message is longer generated:
+C<local> on elements of certain magical arrays and hashes used not to
+arrange to have the element deleted on scope exit, even if the element did
+not exist before C<local>.
 
-    Sequence (?{...}) not terminated or not {}-balanced in regex
+=back
 
-but a new error may be seen:
+=head1 Testing
 
-    Sequence (?{...}) not terminated with ')'
+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.
 
-In addition, literal code blocks within run-time patterns are only
-compiled once, at perl compile-time:
+[ List each test improvement as a =item entry ]
 
-    for my $p (...) {
-        # this 'FOO' block of code is compiled once,
-       # at the same time as the surrounding 'for' loop
-        /$p{(?{FOO;})/;
-    }
+=over 4
 
 =item *
 
-Lexical variables are now sane as regards scope, recursion and closure
-behaviour. In particular, C</A(?{B})C/> behaves (from a closure viewpoint)
-exactly like C</A/ && do { B } && /C/>, while  C<qr/A(?{B})C/> is like
-C<sub {/A/ && do { B } && /C/}>. So this code now works how you might
-expect, creating three regexes that match 0, 1, and 2:
+XXX
 
-    for my $i (0..2) {
-        push @r, qr/^(??{$i})$/;
-    }
-    "1" =~ $r[1]; # matches
+=back
 
-=item *
+=head1 Platform Support
 
-The C<use re 'eval'> pragma is now only required for code blocks defined
-at runtime; in particular in the following, the text of the C<$r> pattern is
-still interpolated into the new pattern and recompiled, but the individual
-compiled code-blocks within C<$r> are reused rather than being recompiled,
-and C<use re 'eval'> isn't needed any more:
+XXX Any changes to platform support should be listed in the sections below.
 
-    my $r = qr/abc(?{....})def/;
-    /xyz$r/;
+[ Within the sections, list each platform as a =item entry with specific
+changes as paragraphs below it. ]
 
-=item *
+=head2 New Platforms
 
-Flow control operators no longer crash. Each code block runs in a new
-dynamic scope, so C<next> etc. will not see any enclosing loops and
-C<caller> will not see any calling subroutines. C<return> returns a value
-from the code block, not from any enclosing subroutine.
+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.
 
-=item *
+=over 4
 
-Perl normally caches the compilation of run-time patterns, and doesn't
-recompile if the pattern hasn't changed; but this is now disabled if
-required for the correct behaviour of closures; for example:
+=item XXX-some-platform
 
-    my $code = '(??{$x})';
-    for my $x (1..3) {
-       # recompile to see fresh value of $x each time
-        $x =~ /$code/;
-    }
+XXX
 
+=back
 
-=item *
+=head2 Discontinued Platforms
 
-The C</msix> and C<(?msix)> etc. flags are now propagated into the return
-value from C<(??{})>; this now works:
+XXX List any platforms that this version of perl no longer compiles on.
 
-    "AB" =~ /a(??{'b'})/i;
+=over 4
 
-=item *
+=item XXX-some-platform
 
-Warnings and errors will appear to come from the surrounding code (or for
-run-time code blocks, from an eval) rather than from an C<re_eval>:
+XXX
 
-    use re 'eval'; $c = '(?{ warn "foo" })'; /$c/;
-    /(?{ warn "foo" })/;
+=back
 
-formerly gave:
+=head2 Platform-Specific Notes
 
-    foo at (re_eval 1) line 1.
-    foo at (re_eval 2) line 1.
+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.
 
-and now gives:
+=over 4
 
-    foo at (eval 1) line 1.
-    foo at /some/prog line 2.
+=item XXX-some-platform
 
-=back
+XXX
 
-=item *
-
-Perl now works as well as can be expected on all releases of Unicode so
-far.  In v5.16, it worked on Unicodes 6.0 and 6.1, but there were
-various bugs for earlier releases; the older the release the more
-problems.
+=back
 
-=item *
+=head1 Internal Changes
 
-C<vec> no longer produces "uninitialized" warnings in lvalue context
-[perl #9423].
+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.
 
-=item *
+[ List each change as a =item entry ]
 
-An optimisation involving fixed strings in regular expressions could cause
-a severe performance penalty in edge cases.  This has been fixed
-[perl #76546].
+=over 4
 
 =item *
 
-In certain cases, including empty subpatterns within a regular expression (such
-as C<(?:)> or C<(?:|)>) could disable some optimizations. This has been fixed.
+XXX
 
-=item *
-
-The "Can't find an opnumber" message that C<prototype> produces when passed
-a string like "CORE::nonexistent_keyword" now passes UTF8 and embedded
-NULs through unchanged [perl #97478].
+=back
 
-=item *
+=head1 Selected Bug Fixes
 
-C<prototype> now treats magical variables like C<$1> the same way as
-non-magical variables when checking for the CORE:: prefix, instead of
-treating them as subroutine names.
+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>.
 
-=item *
+[ List each fix as a =item entry ]
 
-Under threaded perls, a runtime code block in a regular expression could
-corrupt the package name stored in the op tree, resulting in bad reads
-in C<caller>, and possibly crashes [perl #113060].
+=over 4
 
 =item *
 
-Referencing a closure prototype (C<\&{$_[1]}> in an attribute handler for a
-closure) no longer results in a copy of the subroutine (or assertion
-failures on debugging builds).
+A regression introduced in v5.14.0 has been fixed, in which some calls
+to the C<re> module would clobber C<$_>.
 
 =item *
 
-C<eval '__PACKAGE__'> now returns the right answer on threaded builds if
-the current package has been assigned over (as in
-C<*ThisPackage:: = *ThatPackage::>) [perl #78742].
+C<do FILE> now always either sets or clears C<$@>, even when the file can't be
+read. This ensures that testing C<$@> first (as recommended by the
+documentation) always returns the correct result.
 
 =item *
 
-If a package is deleted by code that it calls, it is possible for C<caller>
-to see a stack frame belonging to that deleted package.  C<caller> could
-crash if the stash's memory address was reused for a scalar and a
-substitution was performed on the same scalar [perl #113486].
-
-=item *
+The array iterator used for the C<each @array> construct is now correctly
+reset when C<@array> is cleared (RT #75596). This happens for example when the
+array is globally assigned to, as in C<@array = (...)>, but not when its
+B<values> are assigned to. In terms of the XS API, it means that C<av_clear()>
+will now reset the iterator.
 
-C<UNIVERSAL::can> no longer treats its first argument differently
-depending on whether it is a string or number internally.
+This mirrors the behaviour of the hash iterator when the hash is cleared.
 
 =item *
 
-C<open> with "<&" for the mode checks to see whether the third argument is
-a number, in determining whether to treat it as a file descriptor or a
-handle name.  Magical variables like C<$1> were always failing the numeric
-check and being treated as handle names.
+C<< $class->can >>, C<< $class->isa >>, and C<< $class->DOES >> now return
+correct results, regardless of whether that package referred to by C<$class>
+exists [perl #47113].
 
 =item *
 
-C<warn>'s handling of magical variables (C<$1>, ties) has undergone several
-fixes.  FETCH is only called once now on a tied argument or a tied C<$@>
-[perl #97480].  Tied variables returning objects that stringify as "" are
-no longer ignored.  A tied C<$@> that happened to return a reference the
-I<previous> time is was used is no longer ignored.
+Arriving signals no longer clear C<$@> [perl #45173].
 
 =item *
 
-C<warn ""> now treats C<$@> with a number in it the same way, regardless of
-whether it happened via C<$@=3> or C<$@="3">.  It used to ignore the
-former.  Now it appends "\t...caught", as it has always done with
-C<$@="3">.
+Allow C<my ()> declarations with an empty variable list [perl #113554].
 
 =item *
 
-Numeric operators on magical variables (e.g., S<C<$1 + 1>>) used to use
-floating point operations even where integer operations were more appropriate,
-resulting in loss of accuracy on 64-bit platforms [perl #109542].
+During parsing, subs declared after errors no longer leave stubs
+[perl #113712].
 
 =item *
 
-Unary negation no longer treats a string as a number if the string happened
-to be used as a number at some point.  So, if C<$x> contains the string "dogs",
-C<-$x> returns "-dogs" even if C<$y=0+$x> has happened at some point.
+Closures containing no string evals no longer hang on to their containing
+subroutines, allowing variables closed over by outer subroutines to be
+freed when the outer sub is freed, even if the inner sub still exists
+[perl #89544].
 
 =item *
 
-In Perl 5.14, C<-'-10'> was fixed to return "10", not "+10".  But magical
-variables (C<$1>, ties) were not fixed till now [perl #57706].
+Duplication of in-memory filehandles by opening with a "<&=" or ">&=" mode
+stopped working properly in 5.16.0.  It was causing the new handle to
+reference a different scalar variable.  This has been fixed [perl #113764].
 
 =item *
 
-Unary negation now treats strings consistently, regardless of the internal
-UTF8 flag.
+C<qr//> expressions no longer crash with custom regular expression engines
+that do not set C<offs> at regular expression compilation time
+[perl #112962].
 
-=item *
-
-A regression introduced in Perl v5.16.0 involving
-C<tr/I<SEARCHLIST>/I<REPLACEMENTLIST>/> has been fixed.  Only the first
-instance is supposed to be meaningful if a character appears more than
-once in C<I<SEARCHLIST>>.  Under some circumstances, the final instance
-was overriding all earlier ones.  [perl #113584]
+=back
 
-=item *
+=head1 Known Problems
 
-Regular expressions like C<qr/\87/> previously silently inserted a NUL
-character, thus matching as if it had been written C<qr/\00087/>.  Now it
-matches as if it had been written as C<qr/87/>, with a message that the
-sequence C<"\8"> is unrecognized.
+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. Unfixed
+platform specific bugs also go here.
 
-=item *
+[ List each fix as a =item entry ]
 
-C<__SUB__> now works in special blocks (BEGIN, END, etc.).
+=over 4
 
 =item *
 
-Thread creation on Windows could theoretically result in a crash if done
-inside a BEGIN block.  It still does not work properly, but it no longer
-crashes [perl #111610].
+XXX
 
-=item *
+=back
 
-C<\&{''}> (with the empty string) now autovivifies a stub like any other
-sub name, and no longer produces the "Unable to create sub" error
-[perl #94476].
+=head1 Obituary
 
-=back
+XXX If any significant core contributor has died, we've added a short obituary
+here.
 
 =head1 Acknowledgements
 
 XXX Generate this with:
 
-  perl Porting/acknowledgements.pl v5.17.0..HEAD
+  perl Porting/acknowledgements.pl v5.17.1..HEAD
 
 =head1 Reporting Bugs