Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

perl::critic::policy::testinganddebugging::requireusewarnings(3) [centos man page]

Perl::Critic::Policy::TestingAndDebugging::RequireUseWarUsersContributed Perl DocuPerl::Critic::Policy::TestingAndDebugging::RequireUseWarnings(3)

NAME

       Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings - Always "use warnings".

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       Using warnings, and paying attention to what they say, is probably the single most effective way to improve the quality of your code.  This
       policy requires that the 'use warnings' statement must come before any other statements except "package", "require", and other "use"
       statements.  Thus, all the code in the entire package will be affected.

       There are special exemptions for Moose, Moose::Role, and Moose::Util::TypeConstraints because they enforces warnings; e.g.  'use Moose' is
       treated as equivalent to 'use warnings'.

       This policy will not complain if the file explicitly states that it is compatible with a version of perl prior to 5.6 via an include
       statement, e.g. by having "require 5.005" in it.

       The maximum number of violations per document for this policy defaults to 1.

CONFIGURATION

       If you take make use of things like Moose::Exporter, you can create your own modules that import the warnings pragma into the code that is
       "use"ing them.  There is an option to add to the default set of pragmata and modules in your .perlcriticrc: "equivalent_modules".

	   [TestingAndDebugging::RequireUseWarnings]
	   equivalent_modules = MooseX::My::Sugar

BUGS

       Needs to check for -w on the shebang line.

SEE ALSO

       Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       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

perl v5.16.3							    2014-06-09	  Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings(3)

Check Out this Related Man Page

Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarUsersContributed Perl DocuPerl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings(3)

NAME

       Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings - Prohibit various flavors of "no warnings".

AFFILIATION

       This Policy is part of the core Perl::Critic distribution.

DESCRIPTION

       There are good reasons for disabling certain kinds of warnings.	But if you were wise enough to "use warnings" in the first place, then it
       doesn't make sense to disable them completely.  By default, any "no warnings" statement will violate this policy.  However, you can
       configure this Policy to allow certain types of warnings to be disabled (See "CONFIGURATION").  A bare "no warnings" statement will always
       raise a violation.

CONFIGURATION

       The permitted warning types can be configured via the "allow" option.  The value is a list of whitespace-delimited warning types that you
       want to be able to disable.  See perllexwarn for a list of possible warning types.  An example of this customization:

	   [TestingAndDebugging::ProhibitNoWarnings]
	   allow = uninitialized once

       If a true value is specified for the "allow_with_category_restriction" option, then any "no warnings" that restricts the set of warnings
       that are turned off will pass.

	   [TestingAndDebugging::ProhibitNoWarnings]
	   allow_with_category_restriction = 1

SEE ALSO

       Perl::Critic::Policy::TestingAndDebugging::RequireUseWarnings

AUTHOR

       Jeffrey Ryan Thalhammer <jeff@imaginative-software.com>

COPYRIGHT

       Copyright (c) 2005-2011 Imaginative Software Systems.  All rights reserved.

       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

perl v5.16.3							    2014-06-09	  Perl::Critic::Policy::TestingAndDebugging::ProhibitNoWarnings(3)
Man Page