Skip to content

Commit 50321f0

Browse files
committed
perlapi: Combine all forms of warn() into one entry
This makes it easier for readers to compare them and decide which is best suited for their purposes.
1 parent 27a0538 commit 50321f0

File tree

1 file changed

+16
-39
lines changed

1 file changed

+16
-39
lines changed

util.c

Lines changed: 16 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1947,25 +1947,6 @@ Perl_croak_popstack(void)
19471947
my_exit(1);
19481948
}
19491949

1950-
/*
1951-
=for apidoc warn_sv
1952-
1953-
This is an XS interface to Perl's C<warn> function.
1954-
1955-
C<baseex> is the error message or object. If it is a reference, it
1956-
will be used as-is. Otherwise it is used as a string, and if it does
1957-
not end with a newline then it will be extended with some indication of
1958-
the current location in the code, as described for L</mess_sv>.
1959-
1960-
The error message or object will by default be written to standard error,
1961-
but this is subject to modification by a C<$SIG{__WARN__}> handler.
1962-
1963-
To warn with a simple string message, the L</warn> function may be
1964-
more convenient.
1965-
1966-
=cut
1967-
*/
1968-
19691950
void
19701951
Perl_warn_sv(pTHX_ SV *baseex)
19711952
{
@@ -1975,19 +1956,6 @@ Perl_warn_sv(pTHX_ SV *baseex)
19751956
write_to_stderr(ex);
19761957
}
19771958

1978-
/*
1979-
=for apidoc vwarn
1980-
1981-
This is an XS interface to Perl's C<warn> function.
1982-
1983-
This is like C<L</warn>>, but C<args> are an encapsulated
1984-
argument list.
1985-
1986-
Unlike with L</vcroak>, C<pat> is not permitted to be null.
1987-
1988-
=cut
1989-
*/
1990-
19911959
void
19921960
Perl_vwarn(pTHX_ const char* pat, va_list *args)
19931961
{
@@ -1998,23 +1966,32 @@ Perl_vwarn(pTHX_ const char* pat, va_list *args)
19981966
}
19991967

20001968
/*
2001-
=for apidoc warn
1969+
=for apidoc warn
20021970
=for apidoc_item warn_nocontext
1971+
=for apidoc_item warn_sv
1972+
=for apidoc_item vwarn
20031973
20041974
These are XS interfaces to Perl's C<warn> function.
20051975
2006-
They take a sprintf-style format pattern and argument list, which are used to
2007-
generate a string message. If the message does not end with a newline, then it
2008-
will be extended with some indication of the current location in the code, as
2009-
described for C<L</mess_sv>>.
1976+
The arguments are used to generate a string message. If the message does not
1977+
end with a newline, it will be extended with some indication of the current
1978+
location in the code, as described for C<L</mess_sv>>.
20101979
2011-
The error message or object will by default be written to standard error,
1980+
The message or object will by default be written to standard error,
20121981
but this is subject to modification by a C<$SIG{__WARN__}> handler.
20131982
2014-
Unlike with C<L</croak>>, C<pat> is not permitted to be null.
1983+
In C<warn_sv>, C<baseex> is the message or object. If it
1984+
is a reference, it will be used as-is. Otherwise it is used as a string.
20151985
20161986
__PLAIN_vs_NOCONTEXT_wording__(warn)
20171987
1988+
The arguments to C<vwarn> are specified as a C<va_list>. The arguments to the
1989+
remaining forms are specified as a sprintf-style list of arguments.
1990+
1991+
Unlike with the C<L</croak>> functions, C<pat> is not permitted to be null.
1992+
1993+
See also C<L</warner>>.
1994+
20181995
=cut
20191996
*/
20201997

0 commit comments

Comments
 (0)