summaryrefslogtreecommitdiff
path: root/util.c
diff options
context:
space:
mode:
authorKarl Williamson <khw@cpan.org>2020-07-18 07:06:50 -0600
committerKarl Williamson <khw@cpan.org>2020-08-23 22:22:00 -0600
commit4d4f193c8e0e9e39cf47694e174e7f954c2faa63 (patch)
treeb13ef1670c654f7dcc4b413807cc8904e811d11c /util.c
parentb130c675f86de8e54df11531c16f642a1f2ede52 (diff)
downloadperl-4d4f193c8e0e9e39cf47694e174e7f954c2faa63.tar.gz
Change vwarn pod to be in terms of plain warn
Diffstat (limited to 'util.c')
-rw-r--r--util.c10
1 files changed, 2 insertions, 8 deletions
diff --git a/util.c b/util.c
index a16764b2dc..bd541f84bd 100644
--- a/util.c
+++ b/util.c
@@ -1969,14 +1969,8 @@ Perl_warn_sv(pTHX_ SV *baseex)
This is an XS interface to Perl's C<warn> function.
-C<pat> and C<args> are a sprintf-style format pattern and encapsulated
-argument list. These are used to generate a string message. If the
-message does not end with a newline, then it will be extended with
-some indication of the current location in the code, as described for
-L</mess_sv>.
-
-The error message or object will by default be written to standard error,
-but this is subject to modification by a C<$SIG{__WARN__}> handler.
+This is like L</C<warn>>, but C<args> are an encapsulated
+argument list.
Unlike with L</vcroak>, C<pat> is not permitted to be null.