| ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker |
ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker
require ExtUtils::MM_Unix;
The methods provided by this package are designed to be used in
conjunction with ExtUtils::MakeMaker. When MakeMaker writes a
Makefile, it creates one or more objects that inherit their methods
from a package MM. MM itself doesn't provide any methods, but it
ISA ExtUtils::MM_Unix class. The inheritance tree of MM lets operating
specific packages take the responsibility for all the methods provided
by MM_Unix. We are trying to reduce the number of the necessary
overrides by defining rather primitive operations within
ExtUtils::MM_Unix.
If you are going to write a platform specific MM package, please try to limit the necessary overrides to primitive methods, and if it is not possible to do so, let's work out how to achieve that gain.
If you are overriding any of these methods in your Makefile.PL (in the MY class), please report that to the makemaker mailing list. We are trying to minimize the necessary method overrides and switch to data driven Makefile.PLs wherever possible. In the long run less methods will be overridable via the MY class.
The following description of methods is still under development. Please refer to the code for not suitably documented sections and complain loudly to the makemaker@perl.org mailing list. Better yet, provide a patch.
Not all of the methods below are overridable in a Makefile.PL. Overridable methods are marked as (o). All methods are overridable by a platform specific MM_*.pm file (See the ExtUtils::MM_VMS manpage) and the ExtUtils::MM_OS2 manpage).
my $make_frag = $MM->clean_subdirs_target;
Returns the clean_subdirs target. This is used by the clean target to call clean on any subdirectories which contain Makefiles.
my $make_frag = $mm->constants;
Prints out macros for lots of constants.
$mm->init_DEST
Defines the DESTDIR and DEST* variables paralleling the INSTALL*.
$mm->init_dist;
Defines a lot of macros for distribution support.
macro description default
TAR tar command to use tar TARFLAGS flags to pass to TAR cvf
ZIP zip command to use zip ZIPFLAGS flags to pass to ZIP -r
COMPRESS compression command to gzip --best
use for tarfiles
SUFFIX suffix to put on .gz
compressed files
SHAR shar command to use shar
PREOP extra commands to run before
making the archive
POSTOP extra commands to run after
making the archive
TO_UNIX a command to convert linefeeds
to Unix style in your archive
CI command to checkin your ci -u
sources to version control
RCS_LABEL command to label your sources rcs -Nv$(VERSION_SYM): -q
just after CI is run
DIST_CP $how argument to manicopy() best
when the distdir is created
DIST_DEFAULT default target to use to tardist
create a distribution
DISTVNAME name of the resulting archive $(DISTNAME)-$(VERSION)
(minus suffixes)
my $dist_macros = $mm->dist(%overrides);
Generates a make fragment defining all the macros initialized in init_dist.
%overrides can be used to override any of the above.
my $dist_make_fragment = $MM->dist_core;
Puts the targets necessary for 'make dist' together into one make fragment.
my $make_frag = $MM->dist_target;
Returns the 'dist' target to make an archive for distribution. This target simply checks to make sure the Makefile is up-to-date and depends on $(DIST_DEFAULT).
my $make_frag = $MM->tardist_target;
Returns the 'tardist' target which is simply so 'make tardist' works.
The real work is done by the dynamically named tardistfile_target()
method, tardist should have that as a dependency.
my $make_frag = $MM->zipdist_target;
Returns the 'zipdist' target which is simply so 'make zipdist' works.
The real work is done by the dynamically named zipdistfile_target()
method, zipdist should have that as a dependency.
my $make_frag = $MM->tarfile_target;
The name of this target is the name of the tarball generated by tardist. This target does the actual work of turning the distdir into a tarball.
my $make_frag = $MM->zipfile_target;
The name of this target is the name of the zip file generated by zipdist. This target does the actual work of turning the distdir into a zip file.
my $make_frag = $MM->uutardist_target;
Converts the tarfile into a uuencoded file
my $make_frag = $MM->shdist_target;
Converts the distdir into a shell archive.
my $test = $mm->find_tests;
Returns a string suitable for feeding to the shell to return all tests in t/*.t.
The methods here are called for each MakeMaker object in the order specified by @ExtUtils::MakeMaker::MM_Sections.
$mm->fixin(@files);
Inserts the sharpbang or equivalent magic number to a set of @files.
needs_linking() does.
Called by init_main.
$mm->init_INST;
Called by init_main. Sets up all INST_* variables except those related to XS code. Those are handled in init_xs.
$mm->init_INSTALL;
Called by init_main. Sets up all INSTALL_* variables (except INSTALLDIRS) and *PREFIX.
$mm->init_PERL;
Called by init_main. Sets up ABSPERL, PERL, FULLPERL and all the *PERLRUN* permutations.
PERL is allowed to be miniperl
FULLPERL must be a complete perl
ABSPERL is PERL converted to an absolute path
*PERLRUN contains everything necessary to run perl, find it's
libraries, etc...
*PERLRUNINST is *PERLRUN + everything necessary to find the
modules being built.
$mm->init_PERM
Called by init_main. Initializes PERL_*
$mm->init_xs
Sets up macros having to do with XS code. Currently just INST_STATIC, INST_DYNAMIC and INST_BOOT.
By default the Makefile produced includes all the static extensions in the perl library. (Purified versions of library files, e.g., DynaLoader_pure_p1_c0_032.a are automatically ignored to avoid link errors.)
has_link_code())
On VMS used to insure that colons marking targets are preceded by space - most Unix Makes don't need this, but it's necessary under VMS to distinguish the target delimiter from a colon appearing as part of a filespec.
PERM_RW or the string 644.
Used as the string that is passed
to the chmod command to set the permissions for read/writeable files.
MakeMaker chooses 644 because it has turned out in the past that
relying on the umask provokes hard-to-track bug reports.
When the return value is used by the perl function chmod, it is
interpreted as an octal value.
PERM_RWX or the string 755,
i.e. the string that is passed
to the chmod command to set the permissions for executable files.
See also perl_rw.
$MM->prefixify($var, $prefix, $new_prefix, $default);
Using either $MM->{uc $var} || $Config{lc $var}, it will attempt to replace it's $prefix with a $new_prefix.
Should the $prefix fail to match AND a PREFIX was given as an
argument to WriteMakefile() it will set it to the $new_prefix +
$default. This is for systems whose file layouts don't neatly fit into
our ideas of prefixes.
This is for heuristics which attempt to create directory structures that mirror those of the installed perl.
For example:
$MM->prefixify('installman1dir', '/usr', '/home/foo', 'man/man1');
this will attempt to remove '/usr' from the front of the $MM->{INSTALLMAN1DIR} path (initializing it to $Config{installman1dir} if necessary) and replace it with '/home/foo'. If this fails it will simply use '/home/foo/man/man1'.
() in command line arguments.
Doesn't handle recursive Makefile $(...) constructs,
but handles simple ones.
my $make_frag = $MM->realclean_subdirs_target;
Returns the realclean_subdirs target. This is used by the realclean target to call realclean on any subdirectories which contain Makefiles.
my $man_name = $MM->replace_manpage_separator($file_path);
Takes the name of a package, which may be a nested package, in the
form 'Foo/Bar.pm' and replaces the slash with :: or something else
safe for a man page file name. Returns the replacement.
my $make_frag = $MM->tools_other;
Returns a make fragment containing definitions for:
SHELL, CHMOD, CP, MV, NOOP, NOECHO, RM_F, RM_RF, TEST_F, TOUCH, DEV_NULL, UMASK_NULL, MKPATH, EQUALIZE_TIMESTAMP, WARN_IF_OLD_PACKLIST, UNINST, VERBINST, MOD_INSTALL, DOC_INSTALL and UNINSTALL
init_others() initializes all these values.
the ExtUtils::MakeMaker manpage
| ExtUtils::MM_Unix - methods used by ExtUtils::MakeMaker |