carp::datum::makemaker(3pm) [debian man page]

Datum::MakeMaker(3pm)					User Contributed Perl Documentation				     Datum::MakeMaker(3pm)

NAME

       Carp::Datum::MakeMaker - Offer to strip Carp::Datum calls statically

SYNOPSIS

	# Put this at the top of the Makefile.PL for your module
	use ExtUtils::MakeMaker;       # you may omit this line
	use Carp::Datum::MakeMaker;

DESCRIPTION

       The "Carp::Datum::MakeMaker" module supersedes the regular WriteMakefile() routine of "ExtUtils::MakeMaker".

       When running the Makefile.PL from a module interactively, the user will be asked whether calls to "Carp::Datum" should be stripped at build
       time.

       By default, or when running non-interactively, most calls to Carp::Datum routines will be removed: the "datum_strip" program will be
       invoked to filter *.pm files during the build process.  This program is a mere wrapper for the datum_strip() routine, defined in
       "Carp::Datum::Strip".

       The only call that will not be stripped is the DTRACE() call.  However, it will be dynamically remapped to a "Log::Agent" call.	It cannot
       be statically remapped because of its baroque interface.

       At the top of Makefile.PL, insert

	   use Carp::Datum::MakeMaker;

       which will take care of loading "ExtUtils::MakeMaker".  Note that it makes sense to refer to this module, since "Carp::Datum" is being used
       internally, and therefore the user will not be able to install the module if they do not have "Carp::Datum" already installed.

       If you wish to be nicer about "Carp::Datum" not being installed, you can say instead:

	   use ExtUtils::MakeMaker;
	   eval "use Carp::Datum::MakeMaker;";

	   WriteMakefile(
	       'NAME'	   => "Your::module::name",
	       'PREREQ_PM' => {
		   'Carp::Datum'  => '0.100',
	       },
	   );

       It will allow them to run the Makefile.PL, and yet be reminded about the missing "Carp::Datum" module.  Chances are they won't be able to
       go much farther though...

AUTHORS

       Christophe Dehaudt and Raphael Manfredi are the original authors.

       Send bug reports, hints, tips, suggestions to Dave Hoover at <squirrel@cpan.org>.

SEE ALSO

       Carp::Datum::Strip(3), ExtUtils::MakeMaker(3).

perl v5.10.0							    2006-04-13						     Datum::MakeMaker(3pm)

Datum::Strip(3pm)					User Contributed Perl Documentation					 Datum::Strip(3pm)

NAME

       Carp::Datum::Strip - strips most Carp::Datum calls lexically

SYNOPSIS

	use Carp::Datum::Strip qw(datum_strip);

	datum_strip("-", "-");
	datum_strip($file, "$file.new", ".bak");

DESCRIPTION

       This module exports a single routine, datum_strip(), whose purpose is to remove calls to "Carp::Datum" routines lexically.

       Because stripping is done lexically, there are some restrictions about what is actually supported.  Unless the conventions documented in
       Carp::Datum are followed, stripping will be incorrect.

       The general guidelines are:

       o   Do not use here documents or generalized quotes (qq) within assertion expression or tags.  Write assertions using '' or "", as
	   appropriate.

       o   Assertions can be safely put on several lines, but must end with a semi-colon, outside any string.

       There are two calls that will never be stripped: VERIFY() and DTRACE().	The VERIFY() is meant to be preserved (or "DREQUIRE" would have
       been used).  "DTRACE", when called, will be remapped dynamically to some "Log::Agent" routine, depending on the trace level.  See
       Carp::Datum for details.

INTERFACE

       The interface of the datum_strip() routine is:

       "datum_strip" old_file, new_file, [ext]
	   The old_file specifies the old file path, the one to be stripped.  The stripped version will be written to new_file.

	   If the optional third argument ext is given (e.g. ".bak"), then old_file will be renamed with the supplied extension, and new_file will
	   be renamed old_file.  Renaming only occurs if stripping was successful (i.e. the new file was correctly written to disk).

	   The lowest nine "rwx" mode bits from old_file are preserved when creating new_file.

	   Both old_file and new_file can be set to "-", in which case STDIN and STDOUT are used, respectively, and no renaming can occur, nor any
	   mode bit propagation.

	   Returns true on success, "undef" on error.

AUTHORS

       Christophe Dehaudt and Raphael Manfredi are the original authors.

       Send bug reports, hints, tips, suggestions to Dave Hoover at <squirrel@cpan.org>.

SEE ALSO

       Carp::Datum(3).

perl v5.10.0							    2006-04-13							 Datum::Strip(3pm)