Re: [doc-PATCH] for unpack_str() and question

Message-ID: <75A46BF1A9D8D311863A00508B6259A405F180C1@ATTMSX4>

p4raw-id: //depot/perl@21410

diff --git a/pod/perlapi.pod b/pod/perlapi.pod
index 5453505..f111d0e 100644 (file)
--- a/pod/perlapi.pod
+++ b/pod/perlapi.pod
@@ -725,7 +725,9 @@ Found in file pp_pack.c
 
 =item unpackstring
 
-The engine implementing unpack() Perl function.
+The engine implementing unpack() Perl function. C<unpackstring> puts the
+extracted list items on the stack and returns the number of elements.
+Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
 
        I32     unpackstring(char *pat, char *patend, char *s, char *strend, U32 flags)
 

diff --git a/pp_pack.c b/pp_pack.c
index 7d7bd32..55469fb 100644 (file)
--- a/pp_pack.c
+++ b/pp_pack.c
@@ -513,7 +513,9 @@ Perl_unpack_str(pTHX_ char *pat, register char *patend, register char *s, char *
 /*
 =for apidoc unpackstring
 
-The engine implementing unpack() Perl function.
+The engine implementing unpack() Perl function. C<unpackstring> puts the
+extracted list items on the stack and returns the number of elements.
+Issue C<PUTBACK> before and C<SPAGAIN> after the call to this function.
 
 =cut */