diff options
author | Karl Williamson <khw@cpan.org> | 2019-09-12 14:23:18 -0600 |
---|---|---|
committer | Karl Williamson <khw@cpan.org> | 2019-09-15 10:39:56 -0600 |
commit | 1a0efc9a50cf12f7908e5fc15dbe125c7e7cab94 (patch) | |
tree | bd9d49e33bf827274324367a3b2fb9f42bd0531a | |
parent | 86a87e17c5d1d82c2d23289eee5a7afc7bf11876 (diff) | |
download | perl-1a0efc9a50cf12f7908e5fc15dbe125c7e7cab94.tar.gz |
perlapi: Improve description of is_safe_syscall()
Two parameters weren't described, nor the warnings category used.
-rw-r--r-- | inline.h | 8 |
1 files changed, 6 insertions, 2 deletions
@@ -1892,11 +1892,15 @@ Perl_utf8_to_uvchr_buf_helper(pTHX_ const U8 *s, const U8 *send, STRLEN *retlen) =for apidoc is_safe_syscall -Test that the given C<pv> doesn't contain any internal C<NUL> characters. -If it does, set C<errno> to C<ENOENT>, optionally warn, and return FALSE. +Test that the given C<pv> (with length C<len>) doesn't contain any internal +C<NUL> characters. +If it does, set C<errno> to C<ENOENT>, optionally warn using the C<syscalls> +category, and return FALSE. Return TRUE if the name is safe. +C<what> and C<op_name> are used in any warning. + Used by the C<IS_SAFE_SYSCALL()> macro. =cut |