summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2019-09-12 14:23:18 -0600
committerKarl Williamson <khw@cpan.org>2019-09-15 10:39:56 -0600
commit1a0efc9a50cf12f7908e5fc15dbe125c7e7cab94 (patch)
treebd9d49e33bf827274324367a3b2fb9f42bd0531a
parent86a87e17c5d1d82c2d23289eee5a7afc7bf11876 (diff)
downloadperl-1a0efc9a50cf12f7908e5fc15dbe125c7e7cab94.tar.gz
perlapi: Improve description of is_safe_syscall()
Two parameters weren't described, nor the warnings category used.
-rw-r--r--inline.h8
1 files changed, 6 insertions, 2 deletions
diff --git a/inline.h b/inline.h
index 5a4729a8b4..aa4e7b8fdf 100644
--- a/inline.h
+++ b/inline.h
@@ -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