From 51707595971928e4f48f4871962982d85b856b27 Mon Sep 17 00:00:00 2001 From: Father Chrysostomos Date: Sun, 16 Oct 2011 11:59:41 -0700 Subject: [PATCH] Document calling convention for XS cmp routines --- pod/perlfunc.pod | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/pod/perlfunc.pod b/pod/perlfunc.pod index bff6566..cf610fe 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. -- 2.7.4