This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Document IS_SAFE_SYSCALL
authorKarl Williamson <khw@cpan.org>
Thu, 12 Sep 2019 20:24:48 +0000 (14:24 -0600)
committerKarl Williamson <khw@cpan.org>
Sun, 15 Sep 2019 16:39:56 +0000 (10:39 -0600)
perl.h

diff --git a/perl.h b/perl.h
index 0bda6d0..b1ab81d 100644 (file)
--- a/perl.h
+++ b/perl.h
@@ -7205,8 +7205,18 @@ so no C<x++>.
 #  define do_aexec(really, mark,sp)    do_aexec5(really, mark, sp, 0, 0)
 #endif
 
-/* check embedded \0 characters in pathnames passed to syscalls,
-   but allow one ending \0 */
+
+/*
+=head1 Miscellaneous Functions
+
+=for apidoc Am|bool|IS_SAFE_SYSCALL|NN const char *pv|STRLEN len|NN const char *what|NN const char *op_name
+
+Same as L</is_safe_syscall>.
+
+=cut
+
+Allows one ending \0
+*/
 #define IS_SAFE_SYSCALL(p, len, what, op_name) (Perl_is_safe_syscall(aTHX_ (p), (len), (what), (op_name)))
 
 #define IS_SAFE_PATHNAME(p, len, op_name) IS_SAFE_SYSCALL((p), (len), "pathname", (op_name))