Branch: refs/heads/davem/xspod
  Home:   https://github.com/Perl/perl5
  Commit: 53d9146f7eaf0eccd08f2bc301ce2424170f9218
      
https://github.com/Perl/perl5/commit/53d9146f7eaf0eccd08f2bc301ce2424170f9218
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 88fb9b221bcba5d6c75dcb76060fbf3f9245e45d
      
https://github.com/Perl/perl5/commit/88fb9b221bcba5d6c75dcb76060fbf3f9245e45d
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 74260e4e198ac6c139ad7d8ed73c135538033195
      
https://github.com/Perl/perl5/commit/74260e4e198ac6c139ad7d8ed73c135538033195
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: a15b0e56b70a167456221e3ed10721c15fdefc13
      
https://github.com/Perl/perl5/commit/a15b0e56b70a167456221e3ed10721c15fdefc13
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 1463566d83d7b94c5045970689ceb475767f8560
      
https://github.com/Perl/perl5/commit/1463566d83d7b94c5045970689ceb475767f8560
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 855df4221c8d8d5403cc74e1f213850723a6a0fa
      
https://github.com/Perl/perl5/commit/855df4221c8d8d5403cc74e1f213850723a6a0fa
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: c0cd43bca2c31a8e93c5e6ea9af7861864ed00f9
      
https://github.com/Perl/perl5/commit/c0cd43bca2c31a8e93c5e6ea9af7861864ed00f9
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 7088754f0657847522ab4e483736b667d4576e06
      
https://github.com/Perl/perl5/commit/7088754f0657847522ab4e483736b667d4576e06
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: d07e065215e984be915d4b6dfaa4f0b20e66d76d
      
https://github.com/Perl/perl5/commit/d07e065215e984be915d4b6dfaa4f0b20e66d76d
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: b934cb14a43ea759b4129784c7a110af89ab423c
      
https://github.com/Perl/perl5/commit/b934cb14a43ea759b4129784c7a110af89ab423c
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 68b7aca119ecd2cd566f25d640f239fda59a338b
      
https://github.com/Perl/perl5/commit/68b7aca119ecd2cd566f25d640f239fda59a338b
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update REQUIRE, VERSIONCHECK keywords


  Commit: 261412c92ea524c2a5326166006790cd292b5c39
      
https://github.com/Perl/perl5/commit/261412c92ea524c2a5326166006790cd292b5c39
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update PROTOTYPES: keyword


  Commit: 5bfc7766c1a430033c8be34bbd412279050c8100
      
https://github.com/Perl/perl5/commit/5bfc7766c1a430033c8be34bbd412279050c8100
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update EXPORT_XSUB_SYMBOLS, INCLUDE(_COMMAND)


  Commit: 2d3d34823f2ce229b7f6bd99051a5fd4ef00ed3f
      
https://github.com/Perl/perl5/commit/2d3d34823f2ce229b7f6bd99051a5fd4ef00ed3f
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update TYPEMAP: keyword


  Commit: b518bc737a5e3290f32489d7dd8767aee1cdb11c
      
https://github.com/Perl/perl5/commit/b518bc737a5e3290f32489d7dd8767aee1cdb11c
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update BOOT: keyword


  Commit: 73049754fa3516b64ec1ab4831c735020bcc679f
      
https://github.com/Perl/perl5/commit/73049754fa3516b64ec1ab4831c735020bcc679f
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update FALLBACK: keyword


  Commit: 64cb00d0abfce627d2134e318e5c23dcf2a740bf
      
https://github.com/Perl/perl5/commit/64cb00d0abfce627d2134e318e5c23dcf2a740bf
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: e3ea242f73af0be2c0f9579f85f79a63fb42c1c5
      
https://github.com/Perl/perl5/commit/e3ea242f73af0be2c0f9579f85f79a63fb42c1c5
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 66c57eb0a573e753b9352948902ebe72cc4bc66b
      
https://github.com/Perl/perl5/commit/66c57eb0a573e753b9352948902ebe72cc4bc66b
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update IN_OUT etc section


  Commit: 286e90fc6e3a071353940dc7596c46fbd51273c9
      
https://github.com/Perl/perl5/commit/286e90fc6e3a071353940dc7596c46fbd51273c9
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 86f59bdda7fb7381d783f50aa522402626996be5
      
https://github.com/Perl/perl5/commit/86f59bdda7fb7381d783f50aa522402626996be5
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 2ab94532396ddf8a5ebd7798d0f5297f6554c2af
      
https://github.com/Perl/perl5/commit/2ab94532396ddf8a5ebd7798d0f5297f6554c2af
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: ef9e62342c6961bf2f39a4614f30d5c620243a0c
      
https://github.com/Perl/perl5/commit/ef9e62342c6961bf2f39a4614f30d5c620243a0c
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update 'SCOPE: Keyword' section


  Commit: 342d0e87c4337f236399c662689809aa5e9a15da
      
https://github.com/Perl/perl5/commit/342d0e87c4337f236399c662689809aa5e9a15da
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: bd046ce1ad0c43731de527df86a55600910ef353
      
https://github.com/Perl/perl5/commit/bd046ce1ad0c43731de527df86a55600910ef353
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 257e27e13ed86d3912c73da850abc323c72c07a2
      
https://github.com/Perl/perl5/commit/257e27e13ed86d3912c73da850abc323c72c07a2
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 44b0c500e99fae923935d3d82478e27c1518931c
      
https://github.com/Perl/perl5/commit/44b0c500e99fae923935d3d82478e27c1518931c
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: c0065254f7b0aef8a149d8bf98b3f5210a0098cc
      
https://github.com/Perl/perl5/commit/c0065254f7b0aef8a149d8bf98b3f5210a0098cc
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 027c0006e5a25cfefa3127879a42927b1ed81e16
      
https://github.com/Perl/perl5/commit/027c0006e5a25cfefa3127879a42927b1ed81e16
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: c9ef9317973afb3bdbae9dad3bbad17bda1b9f83
      
https://github.com/Perl/perl5/commit/c9ef9317973afb3bdbae9dad3bbad17bda1b9f83
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 815fd708c551410ac81766e80b27940ebb799221
      
https://github.com/Perl/perl5/commit/815fd708c551410ac81766e80b27940ebb799221
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: c9498f597725a2820cb7f32113a0b44a7ae7c780
      
https://github.com/Perl/perl5/commit/c9498f597725a2820cb7f32113a0b44a7ae7c780
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: f81709256c762f91c27298e62c90dd996b904bd5
      
https://github.com/Perl/perl5/commit/f81709256c762f91c27298e62c90dd996b904bd5
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: d716b2e269eed58285f4f64efcb21375aeaf6825
      
https://github.com/Perl/perl5/commit/d716b2e269eed58285f4f64efcb21375aeaf6825
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 19d1401d728d1124af8b21612a840fa397846401
      
https://github.com/Perl/perl5/commit/19d1401d728d1124af8b21612a840fa397846401
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update: ALIAS

Rewrite this section:

    =head3 The ALIAS: Keyword


  Commit: 7f027d039364e50dc3dc7451d4a3980bcf69571d
      
https://github.com/Perl/perl5/commit/7f027d039364e50dc3dc7451d4a3980bcf69571d
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: df225cdecba56e8ae15a2b49fecf663c5a51cfbe
      
https://github.com/Perl/perl5/commit/df225cdecba56e8ae15a2b49fecf663c5a51cfbe
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs.pod: update: CASE

Rewrite this section:

    =head3 The CASE: Keyword


  Commit: 494b7e45afd7639656e77483dcb327c74a295ff7
      
https://github.com/Perl/perl5/commit/494b7e45afd7639656e77483dcb327c74a295ff7
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: b0ed1804cf9d343c5ae6c478226b13d17ceab248
      
https://github.com/Perl/perl5/commit/b0ed1804cf9d343c5ae6c478226b13d17ceab248
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 9a6dfffd6036adbf71be567d4acb8d11a006dec6
      
https://github.com/Perl/perl5/commit/9a6dfffd6036adbf71be567d4acb8d11a006dec6
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: dcc8456229ac9489f905153d983a13712b37b442
      
https://github.com/Perl/perl5/commit/dcc8456229ac9489f905153d983a13712b37b442
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: dedc44bbe5632ff056dcbef73dcab00dcd3a3dca
      
https://github.com/Perl/perl5/commit/dedc44bbe5632ff056dcbef73dcab00dcd3a3dca
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 63ac12a28e5522c694d52a22d2a7b0fe5c8df591
      
https://github.com/Perl/perl5/commit/63ac12a28e5522c694d52a22d2a7b0fe5c8df591
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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: 6abfedb04644697b18271a2c702dde305749f57a
      
https://github.com/Perl/perl5/commit/6abfedb04644697b18271a2c702dde305749f57a
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 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.)


  Commit: 45673ef5d75d1e58f576cb8206b96f8e98000710
      
https://github.com/Perl/perl5/commit/45673ef5d75d1e58f576cb8206b96f8e98000710
  Author: David Mitchell <[email protected]>
  Date:   2025-12-12 (Fri, 12 Dec 2025)

  Changed paths:
    M dist/ExtUtils-ParseXS/lib/perlxs.pod

  Log Message:
  -----------
  perlxs: more tweaks following code review

The many commits in this branch have completely rewritten perlxs.pod.
This commit applies a second set of minor tweaks suggested by reviewers.


Compare: https://github.com/Perl/perl5/compare/4f3cd1361655...45673ef5d75d

To unsubscribe from these emails, change your notification settings at 
https://github.com/Perl/perl5/settings/notifications

Reply via email to