NAME

VCP::Debug - debugging support for VCP

SYNOPSIS

DESCRIPTION

EXPORTS

The following functions may be exported: "debug", "enable_debug", "debugging" "disable_debug", along with the tags ':all' and ':debug'. Use the latter to head off future namespace pollution in case :all gets expanded in the future..

A warning will be emitted on program exit for any specs that aren't used, to help you make sure that you are using sensible specs.

debug

   debug $foo if debugging $self ;

Emits a line of debugging (a "\n" will be appended). Use debug_some to avoid the "\n". Any undefined parameters will be displayed as <undef>.

debugging

   debug "blah" if debugging ;

Returns TRUE if the caller's module is being debugged

   debug "blah" if debugging $self ;
   debug "blah" if debugging $other, $self ; ## ORs the arguments together

Returns TRUE if any of the arguments are being debugged. Plain strings can be passed or blessed references.

explicitly_debugging

   debug "blah" if explicitly_debugging ;

Returns TRUE if the caller's module is being debugged by a literal match instead of a pattern match. This is used when debugging output would normally be congested with too much crap from a particular subsystem when using a wildcard debug spec (like ".*"), but you want the ability to turn on debugging for that subsystem:

   debug "blah" if explicitly_debugging "VCP::Dest::sort" ;

requires an explicit VCP::Dest::sort to be given in the debug specs.

   debug "blah" if explicitly_debugging $self ;
   debug "blah" if explicitly_debugging $other, $self ; ## ORs the args

Returns TRUE if any of the arguments are being debugged. Plain strings can be passed or blessed references.

disable_debug

Disable all debugging.

enable_debug

   enable_debug ;
   enable_debug( ...debug specs... ) ;

A debug spec is a regular expression that matches the name of a module.

COPYRIGHT

Copyright 2000, Perforce Software, Inc. All Rights Reserved.

This module and the VCP package are licensed according to the terms given in the file LICENSE accompanying this distribution, a copy of which is included in vcp.

AUTHOR

Barrie Slaymaker <barries@slaysys.com>