(perl #120841) document ERRSV and CLEAR_ERRSV()
authorTony Cook <tony@develop-help.com>
Thu, 4 Jul 2019 00:39:19 +0000 (10:39 +1000)
committerTony Cook <tony@develop-help.com>
Mon, 8 Jul 2019 04:14:31 +0000 (14:14 +1000)
perl.h

diff --git a/perl.h b/perl.h
index f5f18ff..ff42636 100644 (file)
--- a/perl.h
+++ b/perl.h
@@ -1335,6 +1335,22 @@ EXTERN_C char *crypt(const char *, const char *);
 #   define RESTORE_ERRNO  (errno = saved_errno)
 #endif
 
+/*
+=head1 Warning and Dieing
+
+=for apidoc Amn|SV *|ERRSV
+
+Returns the SV for C<$@>, creating it if needed.
+
+=for apidoc Am|void|CLEAR_ERRSV
+
+Clear the contents of C<$@>, setting it to the empty string.
+
+This replaces any read-only SV with a fresh SV and removes any magic.
+
+=cut
+*/
+
 #define ERRSV GvSVn(PL_errgv)
 
 /* contains inlined gv_add_by_type */