diff options
author | Karl Williamson <khw@cpan.org> | 2016-02-03 12:03:09 -0700 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2016-02-03 12:09:44 -0700 |
commit | 0c395ea59771c4804bc38e8960b217d58fcf1043 (patch) | |
tree | f68c5cf5ecee87303d3ace0f1920cb931393d75d /handy.h | |
parent | 3a8ba71a30e1f40479d502ed94d67389d4058177 (diff) | |
download | perl-0c395ea59771c4804bc38e8960b217d58fcf1043.tar.gz |
perlapi: Clarify that a literal string must end in a NUL
Some entries already had this. For those, it standardizes the text.
Diffstat (limited to 'handy.h')
-rw-r--r-- | handy.h | 41 |
1 files changed, 23 insertions, 18 deletions
@@ -296,47 +296,49 @@ typedef U64TYPE U64; =head1 SV-Body Allocation =for apidoc Ama|SV*|newSVpvs|const char* s -Like C<newSVpvn>, but takes a literal C<NUL>-terminated string instead of a +Like C<newSVpvn>, but takes a C<NUL>-terminated literal string instead of a string/length pair. =for apidoc Ama|SV*|newSVpvs_flags|const char* s|U32 flags -Like C<newSVpvn_flags>, but takes a literal C<NUL>-terminated string instead of +Like C<newSVpvn_flags>, but takes a C<NUL>-terminated literal string instead of a string/length pair. =for apidoc Ama|SV*|newSVpvs_share|const char* s -Like C<newSVpvn_share>, but takes a literal C<NUL>-terminated string instead of +Like C<newSVpvn_share>, but takes a C<NUL>-terminated literal string instead of a string/length pair and omits the hash parameter. =for apidoc Am|void|sv_catpvs_flags|SV* sv|const char* s|I32 flags -Like C<sv_catpvn_flags>, but takes a literal C<NUL>-terminated string instead +Like C<sv_catpvn_flags>, but takes a C<NUL>-terminated literal string instead of a string/length pair. =for apidoc Am|void|sv_catpvs_nomg|SV* sv|const char* s -Like C<sv_catpvn_nomg>, but takes a literal string instead of a -string/length pair. +Like C<sv_catpvn_nomg>, but takes a C<NUL>-terminated literal string instead of +a string/length pair. =for apidoc Am|void|sv_catpvs|SV* sv|const char* s -Like C<sv_catpvn>, but takes a literal string instead of a string/length pair. +Like C<sv_catpvn>, but takes a C<NUL>-terminated literal string instead of a +string/length pair. =for apidoc Am|void|sv_catpvs_mg|SV* sv|const char* s -Like C<sv_catpvn_mg>, but takes a literal string instead of a +Like C<sv_catpvn_mg>, but takes a C<NUL>-terminated literal string instead of a string/length pair. =for apidoc Am|void|sv_setpvs|SV* sv|const char* s -Like C<sv_setpvn>, but takes a literal string instead of a string/length pair. +Like C<sv_setpvn>, but takes a C<NUL>-terminated literal string instead of a +string/length pair. =for apidoc Am|void|sv_setpvs_mg|SV* sv|const char* s -Like C<sv_setpvn_mg>, but takes a literal string instead of a +Like C<sv_setpvn_mg>, but takes a C<NUL>-terminated literal string instead of a string/length pair. =for apidoc Am|SV *|sv_setref_pvs|const char* s -Like C<sv_setref_pvn>, but takes a literal string instead of a -string/length pair. +Like C<sv_setref_pvn>, but takes a C<NUL>-terminated literal string instead of +a string/length pair. =head1 Memory Management =for apidoc Ama|char*|savepvs|const char* s -Like C<savepvn>, but takes a literal C<NUL>-terminated string instead of a +Like C<savepvn>, but takes a C<NUL>-terminated literal string instead of a string/length pair. =for apidoc Ama|char*|savesharedpvs|const char* s @@ -346,23 +348,26 @@ which is shared between threads. =head1 GV Functions =for apidoc Am|HV*|gv_stashpvs|const char* name|I32 create -Like C<gv_stashpvn>, but takes a literal string instead of a string/length pair. +Like C<gv_stashpvn>, but takes a C<NUL>-terminated literal string instead of a +string/length pair. =head1 Hash Manipulation Functions =for apidoc Am|SV**|hv_fetchs|HV* tb|const char* key|I32 lval -Like C<hv_fetch>, but takes a literal string instead of a string/length pair. +Like C<hv_fetch>, but takes a C<NUL>-terminated literal string instead of a +string/length pair. =for apidoc Am|SV**|hv_stores|HV* tb|const char* key|NULLOK SV* val -Like C<hv_store>, but takes a literal string instead of a string/length pair +Like C<hv_store>, but takes a C<NUL>-terminated literal string instead of a +string/length pair and omits the hash parameter. =head1 Lexer interface =for apidoc Amx|void|lex_stuff_pvs|const char *pv|U32 flags -Like L</lex_stuff_pvn>, but takes a literal string instead of a -string/length pair. +Like L</lex_stuff_pvn>, but takes a C<NUL>-terminated literal string instead of +a string/length pair. =cut */ |