diff options
| author | Karl Williamson <khw@cpan.org> | 2015-10-20 22:21:42 -0600 |
|---|---|---|
| committer | Karl Williamson <khw@cpan.org> | 2015-12-22 13:16:51 -0700 |
| commit | dc6b097813c9fe5e64d21ab1f4a4b15db79eef09 (patch) | |
| tree | 744e9ae23c3afba7881cddf8acdc02a8a54cf3c3 /autodoc.pl | |
| parent | 2863dafa090626922ead4c80d687c71c1a0afc55 (diff) | |
| download | perl-dc6b097813c9fe5e64d21ab1f4a4b15db79eef09.tar.gz | |
perlapi: Clarify 'string' vs. buffer
A string strictly is NUL terminated, but our terminology is lax
Diffstat (limited to 'autodoc.pl')
| -rw-r--r-- | autodoc.pl | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/autodoc.pl b/autodoc.pl index 865ee08114..ff548fc96b 100644 --- a/autodoc.pl +++ b/autodoc.pl @@ -396,6 +396,11 @@ not part of the public API, and should not be used by extension writers at all. For these reasons, blindly using functions listed in proto.h is to be avoided when writing extensions. +In Perl, unlike C, a string of characters may generally contain embedded +C<NUL> characters. Sometimes in the documentation a Perl string is referred +to as a "buffer" to distinguish it from a C string, but sometimes they are +both just referred to as strings. + Note that all Perl API global variables must be referenced with the C<PL_> prefix. Again, those not listed here are not to be used by extension writers, and can be changed or removed without notice; same with macros. |