Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

devel::patchperl::plugin(3pm) [debian man page]

Devel::PatchPerl::Plugin(3pm)				User Contributed Perl Documentation			     Devel::PatchPerl::Plugin(3pm)

NAME

       Devel::PatchPerl::Plugin - Devel::PatchPerl plugins explained

VERSION

       version 0.72

DESCRIPTION

       This document explains the Devel::PatchPerl plugin system.

       Plugins are a mechanism for providing additional functionality to Devel::PatchPerl.

       Plugins are searched for in the Devel::PatchPerl::Plugin namespace.

INITIALISATION

       The plugin constructor is "patchperl".

       A plugin is specified using the "PERL5_PATCHPERL_PLUGIN" environment variable. It may either be specified in full (ie.
       "Devel::PatchPerl::Plugin::Feegle") or as the short part (ie. "Feegle").

	 $ export PERL5_PATCHPERL_PLUGIN=Devel::PatchPerl::Plugin::Feegle

	 $ export PERL5_PATCHPERL_PLUGIN=Feegle

       When Devel::PatchPerl has identified the perl source patch and done its patching it will attempt to load the plugin identified. It will
       then call the class method "patchperl" for the plugin package, with the following parameters:

	 'version', the Perl version of the source tree;
	 'source', the absolute path to the Perl source tree;
	 'patchexe', the 'patch' utility that can be used;

       Plugins are called with the current working directory being the root of the Perl source tree, ie. "source".

       Summarised:

	 $ENV{PERL5_PATCHPERL_PLUGIN} = 'Devel::PatchPerl::Plugin::Feegle';

	 my $plugin = $ENV{PERL5_PATCHPERL_PLUGIN};

	 eval "require $plugin";

	 eval {
	   $plugin->patchperl( version => $vers, source => $srcdir, patchexe => $patch );
	 };

WHAT CAN PLUGINS DO
?
       Anything you desire to a Perl source tree.

WHY USE AN ENVIRONMENT VARIABLE TO SPECIFY PLUGINS
?
       So that indicating a plugin to use can be specified independently of whatever mechanism is calling Devel::PatchPerl to do its bidding.

       Think perlbrew.

AUTHOR

       Chris Williams <chris@bingosnet.co.uk>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Chris Williams and Marcus Holland-Moritz.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-06-04					     Devel::PatchPerl::Plugin(3pm)

Check Out this Related Man Page

Devel::PatchPerl::Hints(3pm)				User Contributed Perl Documentation			      Devel::PatchPerl::Hints(3pm)

NAME

       Devel::PatchPerl::Hints - replacement 'hints' files

VERSION

       version 0.72

SYNOPSIS

	 use Devel::PatchPerl::Hints;

	 if ( my $content = Devel::PatchPerl::Hints->hint_file() ) {
	   chmod 0644, 'hints/netbsd.sh' or die "$!";
	   open my $hints, '>', 'hints/netbsd.sh' or die "$!";
	   print $hints $content;
	   close $hints;
	 }

DESCRIPTION

       Sometimes there is a problem with Perls "hints" file for a particular perl port. This module provides fixed "hints" files encoded using
       "MIME::Base64".

FUNCTION

       The function is exported, but has to implicitly imported into the requesting package.

	 use Devel::PatchPerl::Hints qw[hint_file];

       It may also be called as a class method:

	 use Devel::PatchPerl::Hints;

	 my $content = Devel::PatchPerl::Hints->hint_file();

       "hint_file"
	   Takes an optional argument which is the OS name ( as would be returned by $^O ).  By default it will use $^O.

	   In a scalar context, Will return the decoded content of the "hints" file suitable for writing straight to a file handle or undef list
	   if there isn't an applicable "hints" file for the given or derived OS.

	   If called in a list context, will return a list, the first item will be the name of the "hints" file that will need to be amended, the
	   second item will be a string with the decoded content of the "hints" file suitable for writing straight to a file handle. Otherwise an
	   empty list will be returned.

AUTHOR

       Chris Williams <chris@bingosnet.co.uk>

COPYRIGHT AND LICENSE

       This software is copyright (c) 2012 by Chris Williams and Marcus Holland-Moritz.

       This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.

perl v5.14.2							    2012-06-04					      Devel::PatchPerl::Hints(3pm)
Man Page