summaryrefslogtreecommitdiff
path: root/pod/perlfunc.pod
diff options
context:
space:
mode:
authorFather Chrysostomos <sprout@cpan.org>2011-10-16 11:59:41 -0700
committerFather Chrysostomos <sprout@cpan.org>2011-10-16 11:59:41 -0700
commit51707595971928e4f48f4871962982d85b856b27 (patch)
tree1d7c75173708fc3256f4300e4e4fc7549dd932a2 /pod/perlfunc.pod
parent5ae38afedfd6367f5e85e3f1aa329082622f478a (diff)
downloadperl-51707595971928e4f48f4871962982d85b856b27.tar.gz
Document calling convention for XS cmp routines
Diffstat (limited to 'pod/perlfunc.pod')
-rw-r--r--pod/perlfunc.pod4
1 files changed, 4 insertions, 0 deletions
diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod
index bff6566c8d..cf610fed8e 100644
--- a/pod/perlfunc.pod
+++ b/pod/perlfunc.pod
@@ -5878,6 +5878,10 @@ into the subroutine as the package global variables $a and $b (see example
below). Note that in the latter case, it is usually highly counter-productive
to declare $a and $b as lexicals.
+If the subroutine is an XSUB, the elements to be compared are pushed on to
+the stack, the way arguments are usually passed to XSUBs. $a and $b are
+not set.
+
The values to be compared are always passed by reference and should not
be modified.