warnings.h: Add pod about finding the XS warning category
authorKarl Williamson <khw@cpan.org>
Thu, 29 Aug 2019 22:52:45 +0000 (16:52 -0600)
committerKarl Williamson <khw@cpan.org>
Tue, 3 Sep 2019 03:52:10 +0000 (21:52 -0600)
The XS category names are easily derivable from the chart of perl-space
categories.

regen/warnings.pl
warnings.h

index d761e5d..56186c5 100644 (file)
@@ -388,6 +388,13 @@ EOM
 
 =head1 Warning and Dieing
 
+In all these calls, the C<U32 wI<n>> parameters are warning category
+constants.  You can see the ones currently available in
+L<warnings/Category Hierarchy>, just capitalize all letters in the names
+and prefix them by C<WARN_>.  So, for example, the category C<void> used in a
+perl program becomes C<WARN_VOID> when used in XS code and passed to one of
+the calls below.
+
 =for apidoc Am|bool|ckWARN|U32 w
 
 Returns a boolean as to whether or not warnings are enabled for the warning
index 6f0bf6b..c94494f 100644 (file)
 
 =head1 Warning and Dieing
 
+In all these calls, the C<U32 wI<n>> parameters are warning category
+constants.  You can see the ones currently available in
+L<warnings/Category Hierarchy>, just capitalize all letters in the names
+and prefix them by C<WARN_>.  So, for example, the category C<void> used in a
+perl program becomes C<WARN_VOID> when used in XS code and passed to one of
+the calls below.
+
 =for apidoc Am|bool|ckWARN|U32 w
 
 Returns a boolean as to whether or not warnings are enabled for the warning