From 3a1b08584501598bc42fd18f6ce9ba051e867bc4 Mon Sep 17 00:00:00 2001 From: Nicholas Clark Date: Thu, 7 Oct 2010 11:19:26 +0100 Subject: Improve XSLoader::load documentation. Document that all arguments are passed on to the module's bootstrap function, and the behaviour of the bootstrap function in modules built by xsubpp. --- dist/XSLoader/XSLoader_pm.PL | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'dist/XSLoader') diff --git a/dist/XSLoader/XSLoader_pm.PL b/dist/XSLoader/XSLoader_pm.PL index 47492e1da8..66afa8e6e0 100644 --- a/dist/XSLoader/XSLoader_pm.PL +++ b/dist/XSLoader/XSLoader_pm.PL @@ -274,18 +274,22 @@ in F) and XS code (defined in F). If this Perl code makes calls into this XS code, and/or this XS code makes calls to the Perl code, one should be careful with the order of initialization. -The call to C (or C) has three side effects: +The call to C (or C) calls the module's +bootstrap code. For modules build by F (nearly all modules) this +has three side effects: =over =item * -if C<$VERSION> was specified, a sanity check is done to ensure that the -versions of the F<.pm> and the (compiled) F<.xs> parts are compatible; +A sanity check is done to ensure that the versions of the F<.pm> and the +(compiled) F<.xs> parts are compatible. If C<$VERSION> was specified, this +is used for the check. If not specified, it defaults to +C<$XS_VERSION // $VERSION> (in the module's namespace) =item * -the XSUBs are made accessible from Perl; +the XSUBs are made accessible from Perl =item * -- cgit v1.2.1