Skip to content

Commit 560391d

Browse files
committed
perlxs.pod: update BOOT: keyword
1 parent 09e774d commit 560391d

File tree

1 file changed

+12
-13
lines changed

1 file changed

+12
-13
lines changed

dist/ExtUtils-ParseXS/lib/perlxs.pod

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1876,20 +1876,19 @@ typemaps.
18761876

18771877
=head3 The BOOT: Keyword
18781878

1879-
The BOOT: keyword is used to add code to the extension's bootstrap
1880-
function. The bootstrap function is generated by the B<xsubpp> compiler and
1881-
normally holds the statements necessary to register any XSUBs with Perl.
1882-
With the BOOT: keyword the programmer can tell the compiler to add extra
1883-
statements to the bootstrap function.
1884-
1885-
This keyword may be used any time after the first MODULE keyword and should
1886-
appear on a line by itself. The first blank line after the keyword will
1887-
terminate the code block.
1888-
18891879
BOOT:
1890-
# The following message will be printed when the
1891-
# bootstrap function executes.
1892-
printf("Hello from the bootstrap!\n");
1880+
# Print a message when the module is loaded
1881+
printf("Hello from the bootstrap!\n");
1882+
1883+
The C<BOOT> keyword is used to add code to the extension's bootstrap
1884+
function. This function is generated by the XS parser and normally holds
1885+
the statements necessary to register any XSUBs with Perl. It is usually
1886+
called once, at C<use Foo::Bar> time.
1887+
1888+
This keyword should appear on a line by itself. All subsequent lines will
1889+
be interpreted as lines of C code to pass through, including C
1890+
preprocessor directives, but excluding POD and C<#> comments; until the
1891+
next keyword or possible start of a new XSUB (C</\n\n\S/>).
18931892

18941893
=head3 The FALLBACK: Keyword
18951894

0 commit comments

Comments
 (0)