Skip to content

Commit

Permalink
Document gv_stashsvpvn_cached
Browse files Browse the repository at this point in the history
  • Loading branch information
khwilliamson committed Apr 14, 2021
1 parent 99eff29 commit 85bf2e9
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 5 deletions.
2 changes: 1 addition & 1 deletion embed.fnc
Expand Up @@ -1004,7 +1004,7 @@ p |void |gv_setref |NN SV *const dsv|NN SV *const ssv
Apd |HV* |gv_stashpv |NN const char* name|I32 flags
Apd |HV* |gv_stashpvn |NN const char* name|U32 namelen|I32 flags
#if defined(PERL_IN_GV_C) || defined(PERL_IN_UNIVERSAL_C)
EpG |HV* |gv_stashsvpvn_cached |NULLOK SV *namesv|NULLOK const char* name|U32 namelen|I32 flags
EpGd |HV* |gv_stashsvpvn_cached|SV *namesv|const char* name|U32 namelen|I32 flags
#endif
#if defined(PERL_IN_GV_C)
i |HV* |gv_stashpvn_internal |NN const char* name|U32 namelen|I32 flags
Expand Down
14 changes: 10 additions & 4 deletions gv.c
Expand Up @@ -1543,17 +1543,23 @@ S_gv_stashpvn_internal(pTHX_ const char *name, U32 namelen, I32 flags)
}

/*
gv_stashsvpvn_cached
=for apidoc gv_stashsvpvn_cached
Returns a pointer to the stash for a specified package, possibly
cached. Implements both C<L</gv_stashpvn>> and C<L</gv_stashsv>>.
cached. Implements both L<perlapi/C<gv_stashpvn>> and
L<perlapi/C<gv_stashsv>>.
Requires one of either C<namesv> or C<namepv> to be non-null.
See C<L</gv_stashpvn>> for details on C<flags>.
If the flag C<GV_CACHE_ONLY> is set, return the stash only if found in the
cache; see L<perlapi/C<gv_stashpvn>> for details on the other C<flags>.
Note the sv interface is strongly preferred for performance reasons.
Note it is strongly preferred for C<namesv> to be non-null, for performance
reasons.
=for apidoc Emnh||GV_CACHE_ONLY
=cut
*/

#define PERL_ARGS_ASSERT_GV_STASHSVPVN_CACHED \
Expand Down

0 comments on commit 85bf2e9

Please sign in to comment.