This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Mention ppport.h and its --api-info switch in perlguts.
authorMarcus Holland-Moritz <mhx-perl@gmx.net>
Thu, 30 Dec 2004 18:29:02 +0000 (18:29 +0000)
committerMarcus Holland-Moritz <mhx-perl@gmx.net>
Thu, 30 Dec 2004 18:29:02 +0000 (18:29 +0000)
p4raw-id: //depot/perl@23712

pod/perlguts.pod

index 5eb46d2..4d04531 100644 (file)
@@ -2283,6 +2283,26 @@ source, like this:
 Please try and supply some documentation if you add functions to the
 Perl core.
 
+=head2 Backwards compatibility
+
+The Perl API changes over time. New functions are added or the interfaces
+of existing functions are changed. The C<Devel::PPPort> module tries to
+provide compatibility code for some of these changes, so XS writers don't
+have to code it themselves when supporting multiple versions of Perl.
+
+C<Devel::PPPort> generates a C header file F<ppport.h> that can also
+be run as a Perl script. To generate F<ppport.h>, run:
+
+    perl -MDevel::PPPort -eDevel::PPPort::WriteFile
+
+Besides checking existing XS code, the script can also be used to retrieve
+compatibility information for various API calls using the C<--api-info>
+command line switch. For example:
+
+  % perl ppport.h --api-info=sv_magicext
+
+For details, see C<perldoc ppport.h>.
+
 =head1 Unicode Support
 
 Perl 5.6.0 introduced Unicode support. It's important for porters and XS