Branch: refs/heads/davem/xspod
Home: https://github.com/Perl/perl5
Commit: 94f9310edd4c50e7997bfa00185334cbfce2a8cb
https://github.com/Perl/perl5/commit/94f9310edd4c50e7997bfa00185334cbfce2a8cb
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: remove section on %v
The XS parser supported an extremely obscure bit of functionality which
made use of the %v package variable to maintain state between different
bits of typemap processing. This was accidentally broken in 5.10.0:
refactoring removed the 'use vars "%v"' line, and no one seemed to
notice or care.
Also, the sole example of its use in the docs seemed to be obscure,
confusing and probably wrong.
There was a consensus in the discussion at
http://nntp.perl.org/group/perl.perl5.porters/267667
that we should stop documenting this feature rather than trying to fix
it.
Commit: a6b063ae096ae8d14d39ed6de39a64db46dd7aa0
https://github.com/Perl/perl5/commit/a6b063ae096ae8d14d39ed6de39a64db46dd7aa0
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: reindent and reformat code examples
The various XS code examples had odd and inconsistent indentation (often
with 5 leading spaces) and inconsistent formatting, e.g. foo(a,b) vs
foo( a, b ) vs foo(a, b). Fix that, and also remove any tab chars.
Whitespace-only change.
Commit: d83ee3aebab962b551b401acd0e74f65f28a043d
https://github.com/Perl/perl5/commit/d83ee3aebab962b551b401acd0e74f65f28a043d
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: delete most non-ref sections
This commit is a simple cut which deletes several '=head2' sections from
perlxs.pod. The next commit will tidy up and fix any broken links etc.
These sections are more tutorial-like, and aren't in line with the goal
of this branch that perlxs.pod becomes purely a reference manual for XS.
Any relevant information from these sections may be incorporated later
into new sections in perlxs.pod and/or be included in a future rewrite
of perlxstut.pod.
The sections deleted are:
=head2 Introduction
=head2 On The Road
=head2 The Anatomy of an XSUB
=head2 The Argument Stack
=head2 The RETVAL Variable
=head2 Returning SVs, AVs and HVs through RETVAL
=head2 Returning Undef And Empty Lists
=head2 Interface Strategy
=head2 Perl Objects And C Structures
Commit: 8112b82113d1117a64e60fb6c999266c02ac28e1
https://github.com/Perl/perl5/commit/8112b82113d1117a64e60fb6c999266c02ac28e1
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M XSUB.h
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: fix up links after deleting sections
The previous commit deleted several sections from perlxs.pod. This
commit fixes things up; done as a separate commit so that the changes
aren't drowned out in the diff listing.
Commit: a87aad8e590d9597d430c91834c99795c60ecbf9
https://github.com/Perl/perl5/commit/a87aad8e590d9597d430c91834c99795c60ecbf9
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: reorder sections
This big commit does a series of plain cut+pastes to reorder all the
=head2 sections within the file.
This changes the order from semi-random into roughly the order the
various XS keywords would appear within an XS file, and then within an
XSUB declaration/definition.
No changes have been made to the text: simply that all lines from a
particular '^=head2' up until the next head2 have been cut+paste as
a single unit.
No attempt has been made yet to make the text consistent with the new
ordering; that will be done by the subsequent commits of this branch.
The previous ordering in this file was:
=head1 NAME
=head1 DESCRIPTION
=head2 The MODULE Keyword
=head2 The PACKAGE Keyword
=head2 The PREFIX Keyword
=head2 The OUTPUT: Keyword
=head2 The NO_OUTPUT Keyword
=head2 The CODE: Keyword
=head2 The INIT: Keyword
=head2 The NO_INIT Keyword
=head2 The TYPEMAP: Keyword
=head2 Initializing Function Parameters
=head2 Default Parameter Values
=head2 The PREINIT: Keyword
=head2 The SCOPE: Keyword
=head2 The INPUT: Keyword
=head2 The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords
=head2 The C<length(NAME)> Keyword
=head2 Variable-length Parameter Lists
=head2 The C_ARGS: Keyword
=head2 The PPCODE: Keyword
=head2 The REQUIRE: Keyword
=head2 The CLEANUP: Keyword
=head2 The POSTCALL: Keyword
=head2 The BOOT: Keyword
=head2 The VERSIONCHECK: Keyword
=head2 The PROTOTYPES: Keyword
=head2 The PROTOTYPE: Keyword
=head2 The ALIAS: Keyword
=head2 The OVERLOAD: Keyword
=head2 The FALLBACK: Keyword
=head2 The INTERFACE: Keyword
=head2 The INTERFACE_MACRO: Keyword
=head2 The INCLUDE: Keyword
=head2 The INCLUDE_COMMAND: Keyword
=head2 The CASE: Keyword
=head2 The EXPORT_XSUB_SYMBOLS: Keyword
=head2 The & Unary Operator
=head2 Inserting POD, Comments and C Preprocessor Directives
=head2 Using XS With C++
=head2 Safely Storing Static Data in XS
=head3 MY_CXT REFERENCE
=head1 EXAMPLES
=head1 CAVEATS
=head2 Use of standard C library functions
=head2 Event loops and control flow
=head1 XS VERSION
=head1 AUTHOR DIAGNOSTICS
=head1 AUTHOR
and is now:
=head1 NAME
=head1 DESCRIPTION
=head2 The MODULE Keyword
=head2 The PACKAGE Keyword
=head2 The PREFIX Keyword
=head2 Inserting POD, Comments and C Preprocessor Directives
=head2 The REQUIRE: Keyword
=head2 The VERSIONCHECK: Keyword
=head2 The PROTOTYPES: Keyword
=head2 The EXPORT_XSUB_SYMBOLS: Keyword
=head2 The INCLUDE: Keyword
=head2 The INCLUDE_COMMAND: Keyword
=head2 The TYPEMAP: Keyword
=head2 The BOOT: Keyword
=head2 The FALLBACK: Keyword
=head2 The NO_OUTPUT Keyword
=head2 The IN/OUTLIST/IN_OUTLIST/OUT/IN_OUT Keywords
=head2 Default Parameter Values
=head2 The C<length(NAME)> Keyword
=head2 Variable-length Parameter Lists
=head2 The PREINIT: Keyword
=head2 The INPUT: Keyword
=head2 The NO_INIT Keyword
=head2 Initializing Function Parameters
=head2 The & Unary Operator
=head2 The SCOPE: Keyword
=head2 The INIT: Keyword
=head2 The C_ARGS: Keyword
=head2 The CODE: Keyword
=head2 The PPCODE: Keyword
=head2 The POSTCALL: Keyword
=head2 The OUTPUT: Keyword
=head2 The CLEANUP: Keyword
=head2 The PROTOTYPE: Keyword
=head2 The OVERLOAD: Keyword
=head2 The ALIAS: Keyword
=head2 The INTERFACE: Keyword
=head2 The INTERFACE_MACRO: Keyword
=head2 The CASE: Keyword
=head2 Using XS With C++
=head2 Safely Storing Static Data in XS
=head3 MY_CXT REFERENCE
=head1 EXAMPLES
=head1 CAVEATS
=head2 Use of standard C library functions
=head2 Event loops and control flow
=head1 XS VERSION
=head1 AUTHOR DIAGNOSTICS
=head1 AUTHOR
Commit: 4958b08c5f5e8aaa32ca1c096756ce4a64715a4f
https://github.com/Perl/perl5/commit/4958b08c5f5e8aaa32ca1c096756ce4a64715a4f
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: add group headers
Following the previous commit's reordering of the all the =head2
sections, demote most of the =head2 headers to =head3, and add some new
=head2 headers which group together related headers.
Also add some =head3's for a few missing keywords.
Subsequent commits will flesh out the new sections.
Commit: a7d0da8b07d3b514ff7d03b6263a5918d8d983ad
https://github.com/Perl/perl5/commit/a7d0da8b07d3b514ff7d03b6263a5918d8d983ad
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: add a new introductory part
Four commits ago, I removed most of the general text sections in
perlxs (i.e. the ones not specifically about a particular keyword).
Now this commit adds a completely new introductory part to perlxs, about
1200 lines long. It represents an attempt to write a background to what
XS and XSUBs, SVs, typemaps etc are, in a complete and modern way.
The existing reference section for each keyword follows it.
I tried to avoid getting too tutorial-like (that's what perlxstut is
for), but I may have crossed the line in various places. In particular
it has a new section which could have been titled "all the bits of
perlguts you need to know in order to write non-trivial XSUBs without
having to actually read perlguts".
Commit: 9f81438d3a34b3ec94cdab9a03d67ad7db0d707a
https://github.com/Perl/perl5/commit/9f81438d3a34b3ec94cdab9a03d67ad7db0d707a
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: add BNF definition section
Add a section which semi-formally tries to define the syntax and
structue of an XS file, using a BNF-like format.
See http://nntp.perl.org/group/perl.perl5.porters/268701 for the
discussion of this part.
Commit: 07211e343fdb842ff90343a242aed3116de56858
https://github.com/Perl/perl5/commit/07211e343fdb842ff90343a242aed3116de56858
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update MODULE/PACKAGE/PREFIX
Rewrite the POD for these three keywords, and in particular, treat
them as one declaration, rather than three unrelated keywords.
Commit: 979656f230f227e4481eed1166dafb35905d745f
https://github.com/Perl/perl5/commit/979656f230f227e4481eed1166dafb35905d745f
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update file-scoped directive text
Populate the new
=head2 File-scoped XS Keywords and Directives
section, partially by cannibalising (and then deleting) the old
=head3 Inserting POD, Comments and C Preprocessor Directives
subsection. This commit only adds text about directives; subsequent
commits will update the various file-scoped keywords.
Commit: 9559e2e50001932930f4e36c617b73d504fca160
https://github.com/Perl/perl5/commit/9559e2e50001932930f4e36c617b73d504fca160
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update REQUIRE, VERSIONCHECK keywords
Commit: ea0e8730ab790c4870fd0e974607c58c66cc6756
https://github.com/Perl/perl5/commit/ea0e8730ab790c4870fd0e974607c58c66cc6756
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update PROTOTYPES: keyword
Commit: aa277c47f3bcebb815bc7a887a458cd4ab3c6f89
https://github.com/Perl/perl5/commit/aa277c47f3bcebb815bc7a887a458cd4ab3c6f89
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update EXPORT_XSUB_SYMBOLS, INCLUDE(_COMMAND)
Commit: 461a0376e1bd60b85a16ddaf83116be887e5fdd7
https://github.com/Perl/perl5/commit/461a0376e1bd60b85a16ddaf83116be887e5fdd7
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update TYPEMAP: keyword
Commit: 1726e42eaf71b52af659131eae4a4d47d5d483d5
https://github.com/Perl/perl5/commit/1726e42eaf71b52af659131eae4a4d47d5d483d5
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update BOOT: keyword
Commit: 4a3706947f41d1195bc56406c25cd65bafb7fd28
https://github.com/Perl/perl5/commit/4a3706947f41d1195bc56406c25cd65bafb7fd28
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update FALLBACK: keyword
Commit: 19450c1380f17d955e751f46bdacbd5b5aa27443
https://github.com/Perl/perl5/commit/19450c1380f17d955e751f46bdacbd5b5aa27443
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update XSUB Structure + Declaration
Populate the new
=head2 The Structure of an XSUB
=head2 An XSUB Declaration
sections
Commit: 86bca2861477eff28c27586873567501bb1164e9
https://github.com/Perl/perl5/commit/86bca2861477eff28c27586873567501bb1164e9
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update section 'An XSUB Parameter'
Add some initial text for this new section, and also add a new
subsection "XSUB Parameter Placeholders".
Commit: 6acff19bb0955073397dc8e4105a9d3b23f40b0d
https://github.com/Perl/perl5/commit/6acff19bb0955073397dc8e4105a9d3b23f40b0d
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update IN_OUT etc section
Commit: 05c2b711f417c03ebc444fc1af42f7e9dd7064d7
https://github.com/Perl/perl5/commit/05c2b711f417c03ebc444fc1af42f7e9dd7064d7
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M XSUB.h
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update default, length, ellipis params
Rewrite (and retitle) these three subsections:
=head3 Default Parameter Values
=head3 The C<length(NAME)> Keyword
=head3 Variable-length Parameter Lists
Commit: 5c40496c2ec69176444918b6a03e7e788a95fe16
https://github.com/Perl/perl5/commit/5c40496c2ec69176444918b6a03e7e788a95fe16
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: Input part, PREINIT sections
Add text for the new '=head2 The XSUB Input Part' section, and rewrite
the existing entry for the PREINIT keyword.
Commit: 7b99b8c281e91d2c7d4c677dba851221b769aed6
https://github.com/Perl/perl5/commit/7b99b8c281e91d2c7d4c677dba851221b769aed6
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update 'The INPUT: Keyword' section
This commit completely rewrites this section and subsections:
=head3 The INPUT: Keyword
=head4 The NO_INIT Keyword
=head4 Initializing Function Parameters
=head4 The & Unary Operator
It de-emphasises the INPUT keyword and suggests using ANSI XS signatures
etc instead.
Commit: dd1264842a2b60846f2fe8511c3cbec5b0c52ca5
https://github.com/Perl/perl5/commit/dd1264842a2b60846f2fe8511c3cbec5b0c52ca5
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update 'SCOPE: Keyword' section
Commit: 43c6818479bdbd625cb2afefd8fe599beeb7f08a
https://github.com/Perl/perl5/commit/43c6818479bdbd625cb2afefd8fe599beeb7f08a
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: init part, INIT sections
Add text for the new '=head2 The XSUB Init Part' section, and rewrite
the existing entry for the INIT keyword.
Commit: 1f84171cdacace7c4d7e7a93d2ac521866664a22
https://github.com/Perl/perl5/commit/1f84171cdacace7c4d7e7a93d2ac521866664a22
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: code part, autocall, C_ARGS
Add text to the new
=head2 The XSUB Code Part
=head3 Auto-calling a C function
sections, and rewrite the existing
=head4 The C_ARGS: Keyword
section
Commit: 99b8d1a201952d76fe41c5c9e8567b08771c19ea
https://github.com/Perl/perl5/commit/99b8d1a201952d76fe41c5c9e8567b08771c19ea
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: CODE, PPCODE
Rewrite these sections:
=head3 The CODE: Keyword
=head3 The PPCODE: Keyword
Commit: 0b98f815b81c7df3e70d6ba4179ea3a6639cf6ad
https://github.com/Perl/perl5/commit/0b98f815b81c7df3e70d6ba4179ea3a6639cf6ad
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update NOT_IMPLEMENTED_YET: keyword
This keyword formerly wasn't documented. The docs now say "this is what
it is, but don't use it".
Commit: df5bdaf428b54ff4a95b7550bd7bb28e82737d46
https://github.com/Perl/perl5/commit/df5bdaf428b54ff4a95b7550bd7bb28e82737d46
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: output part
Add text to the new
=head2 The XSUB Output Part
section, and rewrite the text in these existing sections:
=head3 The POSTCALL: Keyword
=head3 The OUTPUT: Keyword
Commit: 0aa3aae510c47aaeabd0d11c01a918c3e85f326a
https://github.com/Perl/perl5/commit/0aa3aae510c47aaeabd0d11c01a918c3e85f326a
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: cleanup part
Add text to the new
=head2 The XSUB Cleanup Part
section, and rewrite the text in this existing section:
=head3 The CLEANUP: Keyword
Commit: 59c4ee8a876f23406aac0de91bf9aa7ac73d80ba
https://github.com/Perl/perl5/commit/59c4ee8a876f23406aac0de91bf9aa7ac73d80ba
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update generic intro, PROTOTYPE
Add text to the new
=head2 XSUB Generic Keywords
section, and rewrite the text in this existing section:
=head3 The PROTOTYPE: Keyword
Commit: 36e3cec23c7d6dc5f327f11fde32f3bab779f4c6
https://github.com/Perl/perl5/commit/36e3cec23c7d6dc5f327f11fde32f3bab779f4c6
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: mention package name types
Explain that a 'C' parameter type in an XSUB declaration can actually
be a Perl package name or similar, e.g.
Foo::Bar
f(Foo::Bar obj, char *s)
Commit: 2f2e51bde2989f42b0191b5ed2af504707e5635f
https://github.com/Perl/perl5/commit/2f2e51bde2989f42b0191b5ed2af504707e5635f
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update OVERLOAD, add T_PTROBJ
First, add a new subsection
=head3 T_PTROBJ and opaque handles
to the TYPEMAPs section explaining how this typemap can be used to
map between Perl objects and C library handles. It provides a
fully-worked example of wrapping a simple arithmetic library.
Then completely rewrite the
=head3 The OVERLOAD: Keyword
section. In particular, it now refers to the new T_PTROBJ example and
shows how it can be extended to use overloading.
Commit: ca6528f08b8cbea8be2f4997681f5e4a22f02761
https://github.com/Perl/perl5/commit/ca6528f08b8cbea8be2f4997681f5e4a22f02761
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: document ATTRS
This keyword was undocumented, even though it had been added 25 years
ago.
Commit: d1710da289d6507c992e9e27d663a49d61f870ed
https://github.com/Perl/perl5/commit/d1710da289d6507c992e9e27d663a49d61f870ed
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: add "Sharing XSUB bodies" section
Populate the introduction to this new section.
Commit: d370632d21e090a35ad9d171039e320279354716
https://github.com/Perl/perl5/commit/d370632d21e090a35ad9d171039e320279354716
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: ALIAS
Rewrite this section:
=head3 The ALIAS: Keyword
Commit: e89b380f1c2b92b14713ecf85d58873da24e5340
https://github.com/Perl/perl5/commit/e89b380f1c2b92b14713ecf85d58873da24e5340
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update INTERFACE, INTERFACE_MACRO
Rewrite these sections:
=head3 The INTERFACE: Keyword
=head3 The INTERFACE_MACRO: Keyword
also demote the second to be a head4 child of the first. Then expand
the T_PTROBJ example to use INTERFACE as an alternative to ALIAS.
Commit: 60c50117b1f5451da54cfe25a5a1b711bb07b448
https://github.com/Perl/perl5/commit/60c50117b1f5451da54cfe25a5a1b711bb07b448
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update: CASE
Rewrite this section:
=head3 The CASE: Keyword
Commit: b4ef54ed82f7039974f4eee556f51f50771c4ee8
https://github.com/Perl/perl5/commit/b4ef54ed82f7039974f4eee556f51f50771c4ee8
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: add "Using Typemaps" section
Populate this new section (except for the T_PTROBJ subsection, which had
already been added by an earlier commit within this branch).
Note that the "Common typemaps" subsection could probably benefit
from some further expansion by someone familiar with which built-in
T_FOO entries are useful.
Commit: 3f9725749c1cb2899700ee187ea25222d1df81ea
https://github.com/Perl/perl5/commit/3f9725749c1cb2899700ee187ea25222d1df81ea
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
M t/porting/known_pod_issues.dat
Log Message:
-----------
perlxs.pod: update "Using XS With C++" section
Rewrite this section:
=head2 Using XS With C++
Disclaimer: I've never written a proper C++ program. I had to
(literally) dust off my 34-year old copy of Stroustrup(*) and also do
some Googling. Hopefully what I've written is sane.
(*) This was bought back in the days when people used to to learn things
by buying books, and when I thought that I ought to know something about
this newfangled C++ thing. I never got round to reading all of it: I
discovered Perl around the same time, which looked to be a lot more fun.
Commit: 1128ed48bbfb8126e2ab0dca576c0eeaca6749f3
https://github.com/Perl/perl5/commit/1128ed48bbfb8126e2ab0dca576c0eeaca6749f3
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update MY_CXT section
Revise the text in this section:
=head2 Safely Storing Static Data in XS
Commit: 9c9a244a6dcbc361595be02f76969bcadc00ffdb
https://github.com/Perl/perl5/commit/9c9a244a6dcbc361595be02f76969bcadc00ffdb
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update EXAMPLES section
Rewrite this section:
=head1 EXAMPLES
Basically, delete the one big example in this section and instead
provide links to various other examples already present in this document
instead.
Commit: ae8001269d22dc955b87e8055f07382aee0581ba
https://github.com/Perl/perl5/commit/ae8001269d22dc955b87e8055f07382aee0581ba
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs.pod: update CAVEATS, AUTHOR, A DIAGNOSTICS
Tweak the final few sections of perlxs.pod.
Commit: 8dc934fd23be487bd202eeea10a09e1178f3821c
https://github.com/Perl/perl5/commit/8dc934fd23be487bd202eeea10a09e1178f3821c
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
M dist/ExtUtils-ParseXS/t/001-basic.t
Log Message:
-----------
perlxs.pod: standardise version numbers in the doc
After the big rewrite, various bits of text which describe when a
particular feature was introduced or changed have ended up using a
random mixture of Perl, ParseXS and xsubpp version numbers.
This commit standardises on xsubpp version numbers. These are mostly
the same as ParseXS, but this handles the cases before ParseXS was
split off from xsubpp. Perl versions suffer from not exactly matching
when an xsubpp version number was incremented, and not matching what is
used by the "REQUIRE:" keyword.
This commit also adds a short new section which tries to explain how the
three sets of version numbers are related.
Commit: 412f16eb46ab1f7b4835cab1cb5a4dce9d2cec30
https://github.com/Perl/perl5/commit/412f16eb46ab1f7b4835cab1cb5a4dce9d2cec30
Author: David Mitchell <[email protected]>
Date: 2025-11-09 (Sun, 09 Nov 2025)
Changed paths:
M dist/ExtUtils-ParseXS/lib/perlxs.pod
Log Message:
-----------
perlxs: tweaks following code review
The many commits in this branch have completely rewritten perlxs.pod.
This commit applies all the minor tweaks suggested by reviewers.
(It was far too much like hard work to try and update each individual
commit with the various changes.)
Compare: https://github.com/Perl/perl5/compare/9afbfdafc5e2...412f16eb46ab
To unsubscribe from these emails, change your notification settings at
https://github.com/Perl/perl5/settings/notifications
