diff options
| author | Nicholas Clark <nick@ccl4.org> | 2010-10-07 11:16:30 +0100 |
|---|---|---|
| committer | Nicholas Clark <nick@ccl4.org> | 2010-10-07 11:16:30 +0100 |
| commit | 65fa4aaa41a252fc701a0a3495d91d135a68128a (patch) | |
| tree | c05b6e8e2fc560e6f7b195afd9dd97cf71e9f522 | |
| parent | 579de3920d0046d2ded41710988dda5241ae2283 (diff) | |
| download | perl-65fa4aaa41a252fc701a0a3495d91d135a68128a.tar.gz | |
Improve DynaLoader::bootstrap 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.
| -rw-r--r-- | ext/DynaLoader/DynaLoader_pm.PL | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/ext/DynaLoader/DynaLoader_pm.PL b/ext/DynaLoader/DynaLoader_pm.PL index 776ddf9ef4..2fa33cd523 100644 --- a/ext/DynaLoader/DynaLoader_pm.PL +++ b/ext/DynaLoader/DynaLoader_pm.PL @@ -884,7 +884,7 @@ $filename is not defined then "DynaLoader" will be used. Syntax: -bootstrap($module) +bootstrap($module [...]) This is the normal entry point for automatic dynamic loading in Perl. @@ -937,6 +937,13 @@ it uses the function reference returned by dl_install_xsub for speed) =back +All arguments to bootstrap() are passed to the module's bootstrap function. +The default code generated by F<xsubpp> expects $module [, $version] +If the optional $version argument is not given, it defaults to +C<$XS_VERSION // $VERSION> in the module's symbol table. The default code +compares the Perl-space version with the version of the compiled XS code, +and croaks with an error if they do not match. + =back |