From 1a0efc9a50cf12f7908e5fc15dbe125c7e7cab94 Mon Sep 17 00:00:00 2001
From: Karl Williamson <khw@cpan.org>
Date: Thu, 12 Sep 2019 14:23:18 -0600
Subject: [PATCH] perlapi: Improve description of is_safe_syscall()

Two parameters weren't described, nor the warnings category used.
---
 inline.h | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/inline.h b/inline.h
index 5a4729a..aa4e7b8 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
-- 
1.8.3.1