diff options
author | Perl 5 Porters <perl5-porters@africa.nicoh.com> | 1996-09-20 15:08:33 +0100 |
---|---|---|
committer | Andy Dougherty <doughera@lafcol.lafayette.edu> | 1996-09-20 15:08:33 +0100 |
commit | 184e971831b273a4209000a9990327c3ea67e866 (patch) | |
tree | 4d6ac6b99c1907585bfe284ff6c2d882fa5db009 /pod/perlxstut.pod | |
parent | 9c3bb3dec7e8cf606ffb42be143f70853f7d31a1 (diff) | |
download | perl-184e971831b273a4209000a9990327c3ea67e866.tar.gz |
perl 5.003_06: pod/perlcall.pod pod/perldata.pod pod/perldebug.pod pod/perlembed.pod pod/perlfunc.pod pod/perlipc.pod pod/perlpod.pod pod/perlref.pod pod/perlstyle.pod pod/perlsyn.pod pod/perltie.pod pod/perlxstut.pod
Date: Wed, 11 Sep 1996 11:55:18 -0500
From: "Daniel S. Lewart" <lewart@vadds.cvm.uiuc.edu>
Subject: POD spelling patches
Date: Fri, 20 Sep 1996 15:08:33 +0100 (BST)
From: "Joseph S. Myers" <jsm28@hermes.cam.ac.uk>
Subject: Pod typos, pod2man bugs, and miscellaneous installation comments
Here is a patch for various typos and other defects in the Perl
5.003_05 pods, including the pods embedded in library modules.
Diffstat (limited to 'pod/perlxstut.pod')
-rw-r--r-- | pod/perlxstut.pod | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/pod/perlxstut.pod b/pod/perlxstut.pod index 85a8c71f3f..0c6cf3fb22 100644 --- a/pod/perlxstut.pod +++ b/pod/perlxstut.pod @@ -1,6 +1,6 @@ =head1 NAME -perlXStut - Tutorial for XSUB's +perlXStut - Tutorial for XSUBs =head1 DESCRIPTION @@ -33,7 +33,7 @@ read: =item * -In versions of 5.002 prior to version beta 3, then the line in the .xs file +In versions of 5.002 prior to version beta 3, the line in the .xs file about "PROTOTYPES: DISABLE" will cause a compiler error. Simply remove that line from the file. @@ -63,7 +63,7 @@ Some systems may have installed Perl version 5 as "perl5". =head2 DYNAMIC VERSUS STATIC It is commonly thought that if a system does not have the capability to -dynamically load a library, you cannot build XSUB's. This is incorrect. +dynamically load a library, you cannot build XSUBs. This is incorrect. You I<can> build them, but you must link the XSUB's subroutines with the rest of Perl, creating a new executable. This situation is similar to Perl 4. @@ -201,7 +201,7 @@ Now we run the script and we should see the following output: =head2 EXAMPLE 2 Now let's add to our extension a subroutine that will take a single argument -and return 0 if the argument is even, 1 if the argument is odd. +and return 1 if the argument is even, 0 if the argument is odd. Add the following to the end of Mytest.xs: @@ -261,7 +261,8 @@ h2xs creates a number of files in the extension directory. The file Makefile.PL is a perl script which will generate a true Makefile to build the extension. We'll take a closer look at it later. -The files <extension>.pm and <extension>.xs contain the meat of the extension. +The files E<lt>extensionE<gt>.pm and E<lt>extensionE<gt>.xs contain the meat +of the extension. The .xs file holds the C routines that make up the extension. The .pm file contains routines that tell Perl how to load your extension. @@ -445,7 +446,7 @@ section on the argument stack. =head2 WARNING In general, it's not a good idea to write extensions that modify their input -parameters, as in Example 3. However, in order to better accomodate calling +parameters, as in Example 3. However, in order to better accommodate calling pre-existing C routines, which often do modify their input parameters, this behavior is tolerated. The next example will show how to do this. @@ -684,7 +685,7 @@ usually 0. The "ST" is actually a macro that points to the n'th argument on the argument stack. ST(0) is thus the first argument passed to the XSUB, ST(1) is the second argument, and so on. -When you list the arguments to the XSUB in the .xs file, that tell xsubpp +When you list the arguments to the XSUB in the .xs file, that tells xsubpp which argument corresponds to which of the argument stack (i.e., the first one listed is the first argument, and so on). You invite disaster if you do not list them in the same order as the function expects them. @@ -726,7 +727,7 @@ and L<perlpod>. =head2 Author -Jeff Okamoto <okamoto@corp.hp.com> +Jeff Okamoto E<lt>F<okamoto@corp.hp.com>E<gt> Reviewed and assisted by Dean Roehrich, Ilya Zakharevich, Andreas Koenig, and Tim Bunce. |