Skip to content

Commit 4adf59b

Browse files
committed
xsubpp: update typemap content in man page
What the man page said concerning typemaps, and especially the search path, was out of date.
1 parent 48b0995 commit 4adf59b

File tree

1 file changed

+22
-9
lines changed
  • dist/ExtUtils-ParseXS/lib/ExtUtils

1 file changed

+22
-9
lines changed

dist/ExtUtils-ParseXS/lib/ExtUtils/xsubpp

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,31 @@ B<xsubpp> [B<-v>] [B<-except>] [B<-s pattern>] [B<-prototypes>] [B<-noversionche
6767
This compiler is typically run by the makefiles created by L<ExtUtils::MakeMaker>
6868
or by L<Module::Build> or other Perl module build tools.
6969
70+
I<xsubpp> is just a thin wrapper over C<ExtUtils::ParseXS>.
71+
7072
I<xsubpp> will compile XS code into C code by embedding the constructs
7173
necessary to let C functions manipulate Perl values and creates the glue
7274
necessary to let Perl access those functions. The compiler uses typemaps to
73-
determine how to map C function parameters and variables to Perl values.
75+
determine how to map C function parameters and variables to Perl values
76+
and vice versa.
77+
78+
The compiler will search for typemap files called I<typemap>. It will use
79+
the following search path to find typemaps and apply them in that order,
80+
so later typemaps take precedence:
7481
75-
The compiler will search for typemap files called I<typemap>. It will use
76-
the following search path to find default typemaps, with the rightmost
77-
typemap taking precedence.
82+
any files specifed by -typemap
7883
79-
../../../typemap:../../typemap:../typemap:typemap
84+
map("$_/ExtUtils/typemap", reverse @INC),
8085
81-
It will also use a default typemap installed as C<ExtUtils::typemap>.
86+
../../../../lib/ExtUtils/typemap
87+
../../../../typemap
88+
../../../lib/ExtUtils/typemap
89+
../../../typemap
90+
../../lib/ExtUtils/typemap
91+
../../typemap
92+
../lib/ExtUtils/typemap
93+
../typemap
94+
typemap
8295
8396
=head1 OPTIONS
8497
@@ -97,9 +110,9 @@ Adds exception handling stubs to the C code.
97110
98111
=item B<-typemap typemap>
99112
100-
Indicates that a user-supplied typemap should take precedence over the
101-
default typemaps. This option may be used multiple times, with the last
102-
typemap having the highest precedence.
113+
Indicates that a user-supplied typemap should be applied in additon to any
114+
files found in the standard search path. This option may be used multiple
115+
times, with the last typemap having the highest precedence.
103116
104117
=item B<-output filename>
105118

0 commit comments

Comments
 (0)