summaryrefslogtreecommitdiff
path: root/pod
diff options
context:
space:
mode:
authorKaren Etheridge <ether@cpan.org>2023-02-19 16:16:38 -0800
committerKaren Etheridge <ether@cpan.org>2023-02-20 12:39:59 -0800
commit43ea14c25bbfea3aac6da204fd292f5a5ac19b91 (patch)
tree3151ce8ed81b3b31d349eb64ff8283ababad6110 /pod
parentf073a656444e86e8f3f5592a8f9c0542a8ffc51e (diff)
downloadperl-43ea14c25bbfea3aac6da204fd292f5a5ac19b91.tar.gz
perldelta finalization
- add additions to perldiag - documentation section - remove placeholders - finalize Acknowledgements - fix typos - linkify issue/PR references
Diffstat (limited to 'pod')
-rw-r--r--pod/perldelta.pod456
1 files changed, 254 insertions, 202 deletions
diff --git a/pod/perldelta.pod b/pod/perldelta.pod
index 19a2200f95..f3e6e606e8 100644
--- a/pod/perldelta.pod
+++ b/pod/perldelta.pod
@@ -2,9 +2,6 @@
=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.37.9
=head1 DESCRIPTION
@@ -15,18 +12,8 @@ release.
If you are upgrading from an earlier release such as 5.37.7, first read
L<perl5378delta>, which describes differences between 5.37.7 and 5.37.8.
-=head1 Notice
-
-XXX Any important notices here
-
=head1 Core Enhancements
-XXX New core language features go here. Summarize 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 New C<class> Feature
A new B<experimental> syntax is now available for defining object classes,
@@ -76,14 +63,6 @@ These functions are closely tied to the internals of how the interpreter
works, and could be altered or removed at any time if other internal changes
make that necessary.
-=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 (**{ ... }) removed from the regex engine.
@@ -91,7 +70,7 @@ L</Selected Bug Fixes> section.
This feature was released as part of 5.37.8, after some use and
discussion it was seen as more problematic than understood at first
and has been removed in 5.37.9. It was only ever present in a single
-dev release and has never been released as part of a production perl,
+development release and has never been released as part of a production perl,
thus no deprecation cycle has been performed.
=head1 Deprecations
@@ -103,53 +82,15 @@ string has warned since 5.28. It is now deprecated in both string
interpolation and non-interpolated contexts, and will be removed in
Perl 5.40.
-=head2 Module removals
-
-XXX Remove this section if not applicable.
-
-The following modules will be removed from the core distribution in a
-future release, and will at that time need to be installed from CPAN.
-Distributions on CPAN which require these modules will need to list them as
-prerequisites.
-
-The core versions of these modules will now issue C<"deprecated">-category
-warnings to alert you to this fact. To silence these deprecation warnings,
-install the modules in question from CPAN.
-
-Note that these are (with rare exceptions) fine modules that you are encouraged
-to continue to use. Their disinclusion from core primarily hinges on their
-necessity to bootstrapping a fully functional, CPAN-capable Perl installation,
-not usually on concerns over their design.
-
-=over
-
-=item XXX
-
-XXX Note that deprecated modules should be listed here even if they are listed
-as an updated module in the L</Modules and Pragmata> section.
-
-=back
-
-[ List each other 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 an =item entry ]
-
=over 4
=item *
Temporary ("mortal") copies are no longer created during context exit for
internal static SVs that are in no danger of being prematurely freed.
-[GH #20800]
-
-=item *
-
-XXX
+[L<GH #20800|https://github.com/Perl/perl5/issues/20800>|https://github.com/Perl/perl5/issues/20800]
=back
@@ -203,16 +144,15 @@ XXX
=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<perlclass>
+
+Describes the new C<class> feature.
-=head3 L<XXX>
+=head3 L<perlclassguts>
-XXX Description of the purpose of the new file here
+Describes the internals of the new C<class> feature.
=head2 Changes to Existing Documentation
@@ -220,19 +160,27 @@ We have attempted to update the documentation to reflect the changes
listed in this document. If you find any we have missed, open an issue
at L<https://github.com/Perl/perl5/issues>.
-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.
-
Additionally, the following selected changes have been made:
-=head3 L<XXX>
+=head3 L<perlfunc>
+
+=over 4
+
+=item *
+
+Some wording improvements have been made for the C<ucfirst>, C<push>,
+C<unshift> and C<bless> functions, as well as additional examples added.
+
+=back
+
+=head3 L<perlvar>
=over 4
=item *
-XXX Description of the change here
+Added a section on "Scoping Rules of Regex Variables", and other wording
+improvements made throughout.
=back
@@ -242,175 +190,289 @@ 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.
-
=head2 New Diagnostics
-XXX Newly added diagnostic messages go under here, separated into New Errors
-and New Warnings
-
=head3 New Errors
=over 4
=item *
-XXX L<message|perldiag/"message">
+L<Attempt to bless into a class|perldiag/"Attempt to bless into a class">
-=back
+(F) You are attempting to call C<bless> with a package name that is a
+new-style C<class>. This is not necessary, as instances created by the
+constructor are already in the correct class. Instances cannot be created
+by other means, such as C<bless>.
-=head3 New Warnings
+=item *
-=over 4
+L<Cannot assign :param(%s) to field %s because that name is already in use|perldiag/"Cannot assign :param(%s) to field %s because that name is already in use">
+
+(F) An attempt was made to apply a parameter name to a field, when the name
+is already being used by another field in the same class, or one of its
+parent classes. This would cause a name clash so is not allowed.
=item *
-XXX L<message|perldiag/"message">
+L<Cannot create class %s as it already has a non-empty @ISA|perldiag/"Cannot create class %s as it already has a non-empty @ISA">
-=back
+(F) An attempt was made to create a class out of a package that already has
+an C<@ISA> array, and the array is not empty. This is not permitted, as it
+would lead to a class with inconsistent inheritance.
-=head2 Changes to Existing Diagnostics
+=item *
-XXX Changes (i.e. rewording) of diagnostic messages go here
+L<Cannot invoke a method of "%s" on an instance of "%s"|perldiag/"Cannot invoke a method of "%s" on
+an instance of "%s"">
-=over 4
+(F) You tried to directly call a C<method> subroutine of one class by passing
+in a value that is an instance of a different class. This is not permitted,
+as the method would not have access to the correct instance fields.
=item *
-XXX Describe change here
+L<Cannot invoke method on a non-instance|perldiag/"Cannot invoke method on a non-instance">
-=back
+(F) You tried to directly call a C<method> subroutine of a class by passing
+in a value that is not an instance of that class. This is not permitted, as
+the method would not then have access to its instance fields.
+
+=item *
-=head1 Utility Changes
+L<Cannot '%s' outside of a 'class'|perldiag/"Cannot '%s' outside of a 'class'">
-XXX Changes to installed programs such as F<perldoc> and F<xsubpp> go here.
-Most of these are built within the directory F<utils>.
+(F) You attempted to use one of the keywords that only makes sense inside
+a C<class> definition, at a location that is not inside such a class.
-[ List utility changes as a =head2 entry for each utility and =item
-entries for each change
-Use L<XXX> with program names to get proper documentation linking. ]
+=item *
-=head2 L<XXX>
+L<Cannot reopen existing class "%s"|perldiag/"Cannot reopen existing class "%s"">
-=over 4
+(F) You tried to begin a C<class> definition for a class that already exists.
+A class may only have one definition block.
=item *
-XXX
+L<Can't bless an object reference|perldiag/"Can't bless an object reference">
-=back
+(F) You attempted to call C<bless> on a value that already refers to a real
+object instance.
-=head1 Configuration and Compilation
+=item *
-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.
+L<can't convert empty path|perldiag/"can't convert empty path">
-[ List changes as an =item entry ].
+(F) On Cygwin, you called a path conversion function with an empty path.
+Only non-empty paths are legal.
-=over 4
+=item *
+
+L<Class already has a superclass, cannot add another|perldiag/"Class already has a superclass, cannot add another">
+
+(F) You attempted to specify a second superclass for a C<class> by using
+the C<:isa> attribute, when one is already specified. Unlike classes
+whose instances are created with C<bless>, classes created via the
+C<class> keyword cannot have more than one superclass.
=item *
-C<Configure> probed for the return type of malloc() and free() by
-testing whether declarations for those functions produced a function
-type mismatch with the implementation. On Solaris, with a C++
-compiler, this check always failed, since Solaris instead imports
-malloc() and free() from C<std::> with C<using> for C++ builds. Since
-the return types of malloc() and free() are well defined by the C
-standard, skip probing for them. C<Configure> command-line arguments
-and hints can still override these type in the unlikely case that is
-needed. [github #20806]
+L<Class attribute %s requires a value|perldiag/"Class attribute %s requires a value">
-=back
+(F) You specified an attribute for a class that would require a value to
+be passed in parentheses, but did not provide one. Remember that
+whitespace is B<not> permitted between the attribute name and its value;
+you must write this as
-=head1 Testing
+ class Example::Class :attr(VALUE) ...
-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 summarizing, although the bugs
-that they represent may be covered elsewhere.
+=item *
-XXX If there were no significant test changes, say this:
+L<Class :isa attribute requires a class but "%s" is not one|perldiag/"Class :isa attribute requires a class but "%s" is not one">
-Tests were added and changed to reflect the other additions and changes
-in this release.
+(F) When creating a subclass using the C<class> C<:isa> attribute, the
+named superclass must also be a real class created using the C<class>
+keyword.
-XXX If instead there were significant changes, say this:
+=item *
-Tests were added and changed to reflect the other additions and
-changes in this release. Furthermore, these significant changes were
-made:
+L<Field already has a parameter name, cannot add another|perldiag/"Field already has a parameter name, cannot add another">
-[ List each test improvement as an =item entry ]
+(F) A field may have at most one application of the C<:param> attribute to
+assign a parameter name to it; once applied a second one is not allowed.
-=over 4
+=item *
+
+L<Field attribute %s requires a value|perldiag/"Field attribute %s requires a value">
+
+(F) You specified an attribute for a field that would require a value to
+be passed in parentheses, but did not provide one. Remember that
+whitespace is B<not> permitted between the attribute name and its value;
+you must write this as
+
+ field $var :attr(VALUE) ...
=item *
-XXX
+L<Field %s is not accessible outside a method|perldiag/"Field %s is not accessible outside a method">
-=back
+(F) An attempt was made to access a field variable of a class from code
+that does not appear inside the body of a C<method> subroutine. This is not
+permitted, as only methods will have access to the fields of an instance.
-=head1 Platform Support
+=item *
-XXX Any changes to platform support should be listed in the sections below.
+L<Field %s of "%s" is not accessible in a method of "%s"|perldiag/"Field %s of "%s" is not accessible in a method of "%s"">
-[ Within the sections, list each platform as an =item entry with specific
-changes as paragraphs below it. ]
+(F) An attempt was made to access a field variable of a class, from a
+method of another class nested inside the one that actually defined it.
+This is not permitted, as only methods defined by a given class are
+permitted to access fields of that class.
-=head2 New Platforms
+=item *
-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.
+L<Only scalar fields can take a :param attribute|perldiag/"Only scalar fields can take a :param attribute">
-=over 4
+(F) You tried to apply the C<:param> attribute to an array or hash field.
+Currently this is not permitted.
-=item XXX-some-platform
+=item *
-XXX
+L<Required parameter '%s' is missing for %s constructor|perldiag/"Required parameter '%s' is missing for %s constructor">
-=back
+(F) You called the constructor for a class that has a required named
+parameter, but did not pass that parameter at all.
+
+=item *
-=head2 Discontinued Platforms
+L<Unexpected characters while parsing class :isa attribute: %s|perldiag/"Unexpected characters while parsing class :isa attribute: %s">
-XXX List any platforms that this version of perl no longer compiles on.
+(F) You tried to specify something other than a single class name with an
+optional trailing version number as the value for a C<class> C<:isa>
+attribute. This confused the parser.
+
+=item *
+
+L<Unrecognized class attribute %s|perldiag/"Unrecognized class attribute %s">
+
+(F) You attempted to add a named attribute to a C<class> definition, but
+perl does not recognise the name of the requested attribute.
+
+=item *
+
+L<Unrecognized field attribute %s|perldiag/"Unrecognized field attribute %s">
+
+(F) You attempted to add a named attribute to a C<field> definition, but
+perl does not recognise the name of the requested attribute.
+
+=back
+
+=head3 New Warnings
=over 4
-=item XXX-some-platform
+=item *
-XXX
+L<ADJUST is experimental|perldiag/"ADJUST is experimental">
+
+(S experimental::class) This warning is emitted if you use the C<ADJUST>
+keyword of C<use feature 'class'>. This keyword is currently
+experimental and its behaviour may change in future releases of Perl.
+
+=item *
+
+L<class is experimental|perldiag/"class is experimental">
+
+(S experimental::class) This warning is emitted if you use the C<class>
+keyword of C<use feature 'class'>. This keyword is currently
+experimental and its behaviour may change in future releases of Perl.
+
+=item *
+
+L<Method %s redefined|perldiag/"Method %s redefined">
+
+(W redefine) You redefined a method. To suppress this warning, say
+
+ {
+ no warnings 'redefine';
+ *name = method { ... };
+ }
+
+=item *
+
+L<Odd number of elements in hash field initialization|perldiag/"Odd number of elements in hash field initialization">
+
+(W misc) You specified an odd number of elements to initialise a hash
+field of an object. Hashes are initialised from a list of key/value
+pairs so there must be a corresponding value to every key. The final
+missing value will be filled in with undef instead.
+
+=item *
+
+L<Old package separator "'" deprecated|perldiag/"Old package separator "'" deprecated">
+
+(W deprecated, syntax) You used the old package separator "'" in a
+variable, subroutine or package name. Support for the old package
+separator will be removed in Perl 5.40.
+
+=item *
+
+L<field is experimental|perldiag/"field is experimental">
+
+(S experimental::class) This warning is emitted if you use the C<field>
+keyword of C<use feature 'class'>. This keyword is currently
+experimental and its behaviour may change in future releases of Perl.
+
+=item *
+
+L<method is experimental|perldiag/"method is experimental">
+
+(S experimental::class) This warning is emitted if you use the C<method>
+keyword of C<use feature 'class'>. This keyword is currently
+experimental and its behaviour may change in future releases of Perl.
=back
-=head2 Platform-Specific Notes
+=head2 Changes to Existing Diagnostics
+
+=over 4
+
+=item *
+
+L<Old package separator used in string|perldiag/"Old package separator used in string">
+
+This diagnostic is now also part of the C<deprecated> category.
+
+=back
-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.
+=head1 Configuration and Compilation
=over 4
-=item XXX-some-platform
+=item *
-XXX
+C<Configure> now properly handles quoted elements outputted from gcc. [L<GH #20606|https://github.com/Perl/perl5/issues/20606>]
+
+=item *
+
+C<Configure> probed for the return type of malloc() and free() by
+testing whether declarations for those functions produced a function
+type mismatch with the implementation. On Solaris, with a C++
+compiler, this check always failed, since Solaris instead imports
+malloc() and free() from C<std::> with C<using> for C++ builds. Since
+the return types of malloc() and free() are well defined by the C
+standard, skip probing for them. C<Configure> command-line arguments
+and hints can still override these type in the unlikely case that is
+needed. [L<GH #20806|https://github.com/Perl/perl5/issues/20806>]
=back
-=head1 Internal Changes
+=head1 Testing
-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.
+Tests were added and changed to reflect the other additions and changes
+in this release.
-[ List each change as an =item entry ]
+=head1 Internal Changes
=over 4
@@ -431,11 +493,6 @@ The API function L<perlapi/utf8_length> is now more efficient.
=head1 Selected Bug Fixes
-XXX Important bug fixes in the core language are summarized here. Bug fixes in
-files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
-
-[ List each fix as an =item entry ]
-
=over 4
=item *
@@ -443,25 +500,25 @@ files in F<ext/> and F<lib/> are best summarized in L</Modules and Pragmata>.
Writing to a magic variables associated with the selected output
handle, C<$^>, C<$~>, C<$=>, C<$-> and C<$%>, no longer crashes perl
if the IO object has been cleared from the selected output
-handle. [github #20733]
+handle. [L<GH #20733|https://github.com/Perl/perl5/issues/20733>]
=item *
Redefining a C<use constant> list constant with C<use constant> now
properly warns. This changes the behaviour of C<use constant> but is
-a core change, not a change to F<constant.pm>. [github #20742]
+a core change, not a change to F<constant.pm>. [L<GH #20742|https://github.com/Perl/perl5/issues/20742>]
=item *
Redefining a C<use constant> list constant with an empty prototype
-constant sub would result in an assertion failure. [github #20742]
+constant sub would result in an assertion failure. [L<GH #20742|https://github.com/Perl/perl5/issues/20742>]
=item *
Fixed a regression where the C<INC> method for objects in C<@INC>
would not be resolved by C<AUTOLOAD>, while it was in 5.36. The
C<INCDIR> method for objects in C<@INC> cannot be resolved by
-C<AUTOLOAD> as C<INC> would have been resolved first. [github #20665]
+C<AUTOLOAD> as C<INC> would have been resolved first. [L<GH #20665|https://github.com/Perl/perl5/issues/20665>]
=item *
@@ -500,43 +557,38 @@ C<use locale> and the locale in effect calls for that.
=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. Unfixed
-platform specific bugs also go here.
-
-[ List each fix as an =item entry ]
-
-=over 4
-
-=item *
-
-XXX
-
-=back
-
-=head1 Errata From Previous Releases
-
-=over 4
+=head1 Acknowledgements
-=item *
+Perl 5.37.9 represents approximately 4 weeks of development since Perl
+5.37.8 and contains approximately 24,000 lines of changes across 360 files
+from 32 authors.
-XXX Add anything here that we forgot to add, or were mistaken about, in
-the perldelta of a previous release.
+Excluding auto-generated files, documentation and release tools, there were
+approximately 8,400 lines of changes to 270 .pm, .t, .c and .h files.
-=back
+Perl continues to flourish into its fourth decade thanks to a vibrant
+community of users and developers. The following people are known to have
+contributed the improvements that became Perl 5.37.9:
-=head1 Obituary
+Alexander Nikolov, Alex Davies, Andrew Fresh, Aristotle Pagaltzis, Bartosz
+Jarzyna, Branislav Zahradník, Chad Granum, Craig A. Berry, Dagfinn Ilmari
+Mannsåker, Dan Jacobson, Elvin Aslanov, Håkon Hægland, Hugo van der
+Sanden, James E Keenan, Joe McMahon, Jonathan Stowe, Karen Etheridge, Karl
+Williamson, Kurt Fitzner, Leon Timmermans, Max Maischein, Nicholas Clark,
+Nicolas R, Paul Evans, Paul Marquess, Renee Baecker, Richard Leach, Scott
+Baker, Todd Rinaldo, Tomasz Konojacki, Tony Cook, Yves Orton.
-XXX If any significant core contributor or member of the CPAN community has
-died, add a short obituary here.
-
-=head1 Acknowledgements
+The list above is almost certainly incomplete as it is automatically
+generated from version control history. In particular, it does not include
+the names of the (very much appreciated) contributors who reported issues to
+the Perl bug tracker.
-XXX Generate this with:
+Many of the changes included in this version originated in the CPAN modules
+included in Perl's core. We're grateful to the entire CPAN community for
+helping Perl to flourish.
- perl Porting/acknowledgements.pl v5.37.8..HEAD
+For a more complete list of all of Perl's historical contributors, please
+see the F<AUTHORS> file in the Perl source distribution.
=head1 Reporting Bugs