diff options
author | Nicholas Clark <nick@ccl4.org> | 2007-01-25 20:57:56 +0000 |
---|---|---|
committer | Nicholas Clark <nick@ccl4.org> | 2007-01-25 20:57:56 +0000 |
commit | da51bb9b4f7f527464b5e38aca8bcb956de1bbbc (patch) | |
tree | f2f952634f7d10137a8e0c223426969a64d76ff6 /pod/perlapi.pod | |
parent | ede8ac17cc8980652fa00e4d3b33ce031d6bbd24 (diff) | |
download | perl-da51bb9b4f7f527464b5e38aca8bcb956de1bbbc.tar.gz |
The last parameter to gv_stashpv/gv_stashpvn/gv_stashsv is a bitmask
of flags, not a boolean, so correct the documenation and callers.
p4raw-id: //depot/perl@29977
Diffstat (limited to 'pod/perlapi.pod')
-rw-r--r-- | pod/perlapi.pod | 27 |
1 files changed, 13 insertions, 14 deletions
diff --git a/pod/perlapi.pod b/pod/perlapi.pod index 88f5f791d8..d2259d5234 100644 --- a/pod/perlapi.pod +++ b/pod/perlapi.pod @@ -1358,12 +1358,10 @@ Found in file gv.c =item gv_stashpv X<gv_stashpv> -Returns a pointer to the stash for a specified package. C<name> should -be a valid UTF-8 string and must be null-terminated. If C<create> is set -then the package will be created if it does not already exist. If C<create> -is not set and the package does not exist then NULL is returned. +Returns a pointer to the stash for a specified package. Uses C<strlen> to +determine the length of C<name, then calls C<gv_stashpvn()>. - HV* gv_stashpv(const char* name, I32 create) + HV* gv_stashpv(const char* name, I32 flags) =for hackers Found in file gv.c @@ -1371,13 +1369,15 @@ Found in file gv.c =item gv_stashpvn X<gv_stashpvn> -Returns a pointer to the stash for a specified package. C<name> should -be a valid UTF-8 string. The C<namelen> parameter indicates the length of -the C<name>, in bytes. If C<create> is set then the package will be -created if it does not already exist. If C<create> is not set and the -package does not exist then NULL is returned. +Returns a pointer to the stash for a specified package. The C<namelen> +parameter indicates the length of the C<name>, in bytes. C<flags> is passed +to C<gv_fetchpvn_flags()>, so if set to C<GV_ADD> then the package will be +created if it does not already exist. If the package does not exist and +C<flags> is 0 (or any other setting that does not create packages) then NULL +is returned. - HV* gv_stashpvn(const char* name, U32 namelen, I32 create) + + HV* gv_stashpvn(const char* name, U32 namelen, I32 flags) =for hackers Found in file gv.c @@ -1395,10 +1395,9 @@ Found in file handy.h =item gv_stashsv X<gv_stashsv> -Returns a pointer to the stash for a specified package, which must be a -valid UTF-8 string. See C<gv_stashpv>. +Returns a pointer to the stash for a specified package. See C<gv_stashpvn>. - HV* gv_stashsv(SV* sv, I32 create) + HV* gv_stashsv(SV* sv, I32 flags) =for hackers Found in file gv.c |