.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Perl::Critic::Policy::ErrorHandling::RequireCarping 3pm"
.TH Perl::Critic::Policy::ErrorHandling::RequireCarping 3pm 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Perl::Critic::Policy::ErrorHandling::RequireCarping \- Use functions from Carp instead of "warn" or "die".
.SH AFFILIATION
.IX Header "AFFILIATION"
This Policy is part of the core Perl::Critic
distribution.
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The \f(CW\*(C`die\*(C'\fR and \f(CW\*(C`warn\*(C'\fR functions both report the file and line number
where the exception occurred.  But if someone else is using your
subroutine, they usually don't care where \fByour\fR code blew up.
Instead, they want to know where \fBtheir\fR code invoked the subroutine.
The Carp module provides alternative methods that report the
exception from the caller's file and line number.
.PP
By default, this policy will not complain about \f(CW\*(C`die\*(C'\fR or \f(CW\*(C`warn\*(C'\fR, if
it can determine that the message will always result in a terminal
newline.  Since perl suppresses file names and line numbers in this
situation, it is assumed that no stack traces are desired either and
none of the Carp functions are necessary.
.PP
.Vb 2
\&    die "oops" if $explosion;             #not ok
\&    warn "Where? Where?!" if $tiger;      #not ok
\&
\&    open my $mouth, \*(Aq<\*(Aq, \*(Aqfood\*(Aq
\&        or die \*(Aqof starvation\*(Aq;           #not ok
\&
\&    if (! $dentist_appointment) {
\&        warn "You have bad breath!\en";    #ok
\&    }
\&
\&    die "$clock not set.\en" if $no_time;  #ok
\&
\&    my $message = "$clock not set.\en";
\&    die $message if $no_time;             #not ok, not obvious
.Ve
.SH CONFIGURATION
.IX Header "CONFIGURATION"
By default, this policy allows uses of \f(CW\*(C`die\*(C'\fR and \f(CW\*(C`warn\*(C'\fR ending in an
explicit newline. If you give this policy an
\&\f(CW\*(C`allow_messages_ending_with_newlines\*(C'\fR option in your \fI.perlcriticrc\fR
with a false value, then this policy will prohibit such uses.
.PP
.Vb 2
\&    [ErrorHandling::RequireCarping]
\&    allow_messages_ending_with_newlines = 0
.Ve
.PP
If you give this policy an \f(CW\*(C`allow_in_main_unless_in_subroutine\*(C'\fR option
in your \fI.perlcriticrc\fR with a true value, then this policy will allow
\&\f(CW\*(C`die\*(C'\fR and \f(CW\*(C`warn\*(C'\fR in name space main:: unless they appear in a
subroutine, even if they do not end in an explicit newline.
.PP
.Vb 2
\&    [ErrorHandling::RequireCarping]
\&    allow_in_main_unless_in_subroutine = 1
.Ve
.SH BUGS
.IX Header "BUGS"
Should allow \f(CW\*(C`die\*(C'\fR when it is obvious that the "message" is a reference.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Carp::Always
.SH AUTHOR
.IX Header "AUTHOR"
Jeffrey Ryan Thalhammer <jeff@imaginative\-software.com>
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2005\-2023 Imaginative Software Systems.  All rights reserved.
.PP
This program is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.  The full text of this license
can be found in the LICENSE file included with this module.