ExtUtils::MM_Unix(3)
πΈ NAME πΈ
hey bestie, welcome to ExtUtils::MM_Unix(3) π β the manual page for ExtUtils::MM_Unix, aka methods used by ExtUtils::MakeMaker. slay.
β¨ SYNOPSIS β¨
the whole synopsis is literally just this:
require ExtUtils::MM_Unix;
π DESCRIPTION π
okay so the methods in this package are designed to be used together with ExtUtils::MakeMaker. when MakeMaker writes a Makefile, it creates one or more objects that inherit their methods from a package called MM. and MM itself doesnβt provide any methods, but it ISA ExtUtils::MM_Unix class. the inheritance tree of MM lets operating-specific packages take responsibility for all the methods provided by MM_Unix. the goal is to reduce the number of necessary overrides by defining rather primitive operations within ExtUtils::MM_Unix π«Ά.
if youβre going to write a platform-specific MM package, please try to limit the necessary overrides to primitive methods β and if thatβs not possible, letβs work out how to achieve that gain together. teamwork, no cap π
.
if youβre overriding any of these methods in your Makefile.PL (in the MY class), please report that to the makemaker mailing list. the mission is 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. periodt.
π οΈ METHODS π οΈ
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. iconic behavior only β¨.
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.
cross-platform methods are being moved into MM_Any. if you canβt find something that used to be in here, look in MM_Any π.
π§ Methods π§
os_flavorβ simply says that weβre Unix. thatβs it, thatβs the vibe π¦.c_o (o)β defines the suffix rules to compile different flavors of C files to object files.xs_obj_optβ takes the object file as an argument, and returns the portion of the compile command-line that will output to the specified object file.dbgoutflagβ returns a CC flag that tells the CC to emit a separate debugging symbol file when compiling an object file.cflags (o)β does very much the same as thecflagsscript in the perl distribution. it doesnβt return the whole compiler command line, but initializes all of its parts. theconst_cccmdmethod then actually returns the definition of theCCCMDmacro which uses these parts.const_cccmd (o)β returns the full compiler call for C programs and stores the definition inCONST_CCCMD.const_config (o)β setsSHELLif needed, then defines a couple of constants in the Makefile that are imported from%Config.const_loadlibs (o)β definesEXTRALIBS,LDLOADLIBS,BSLOADLIBS,LD_RUN_PATH. seeExtUtils::Liblistfor details.constants (o)β hereβs the little spell:my $make_frag = $mm->constants;β it prints out macros for lots of constants β¨.depend (o)β same as macro for thedependattribute.init_DESTβ$mm->init_DESTβ defines theDESTDIRandDEST*variables paralleling theINSTALL*.init_distβ$mm->init_dist;β defines a lot of macros for distribution support. hereβs the macro tea β:TARβ tar command to use; defaulttarTARFLAGSβ flags to pass toTAR; defaultcvfZIPβ zip command to use; defaultzipZIPFLAGSβ flags to pass toZIP; default-rCOMPRESSβ compression command to use for tarfiles; defaultgzip --bestSUFFIXβ suffix to put on compressed files; default.gzSHARβ shar command to use; defaultsharPREOPβ extra commands to run before making the archivePOSTOPβ extra commands to run after making the archiveTO_UNIXβ a command to convert linefeeds to Unix style in your archiveCIβ command to checkin your sources to version control; defaultci -uRCS_LABELβ command to label your sources just afterCIis run; defaultrcs -Nv$(VERSION_SYM): -qDIST_CPβ$howargument tomanicopy()when the distdir is created; defaultbestDIST_DEFAULTβ default target to use to create a distribution; defaulttardistDISTVNAMEβ name of the resulting archive (minus suffixes); default$(DISTNAME)-$(VERSION)
dist (o)βmy $dist_macros = $mm->dist(%overrides);β generates a make fragment defining all the macros initialized ininit_dist.%overridescan be used to override any of the above π.dist_basics (o)β defines the targetsdistclean,distcheck,skipcheck,manifest,veryclean.dist_ci (o)β defines a check in target for RCS.dist_core (o)βmy $dist_make_fragment = $MM->dist_core;β puts the targets necessary for'make dist'together into one make fragment.dist_targetβ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).tardist_targetβ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 namedtardistfile_target()method,tardistshould have that as a dependency.zipdist_targetβ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 namedzipdistfile_target()method,zipdistshould have that as a dependency.tarfile_targetβmy $make_frag = $MM->tarfile_target;β the name of this target is the name of the tarball generated bytardist. this target does the actual work of turning the distdir into a tarball.zipfile_targetβmy $make_frag = $MM->zipfile_target;β the name of this target is the name of the zip file generated byzipdist. this target does the actual work of turning the distdir into a zip file.uutardist_targetβmy $make_frag = $MM->uutardist_target;β converts the tarfile into a uuencoded file.shdist_targetβmy $make_frag = $MM->shdist_target;β converts the distdir into a shell archive.dlsyms (o)β used by some OS' to defineDL_FUNCSandDL_VARSand write the*.expfiles. normally just returns an empty string.dynamic_bs (o)β defines targets for bootstrap files.dynamic_lib (o)β defines how to produce the*.so(or equivalent) files.xs_dynamic_lib_macrosβ defines the macros for the"dynamic_lib"section.xs_make_dynamic_libβ defines the recipes for the"dynamic_lib"section.exescanβ deprecated method. uselibscaninstead. β οΈextliblistβ called byinit_others, and calls extExtUtils::Liblist. seeExtUtils::Liblistfor details.find_perlβ finds the executablesPERLandFULLPERL.fixinβ$mm->fixin(@files);β inserts the sharpbang or equivalent magic number to a set of@files.force (o)β writes an emptyFORCE:target.guess_nameβ guess the name of this package by examining the working directoryβs name. MakeMaker calls this only if the developer has not supplied aNAMEattribute.has_link_codeβ returns true if C, XS,MYEXTLIBor similar objects exist within this object that need a compiler. does not descend into subdirectories asneeds_linking()does.init_dirscanβ scans the directory structure and initializesDIR,XS,XS_FILES,C,C_FILES,O_FILES,H,H_FILES,PL_FILES,EXE_FILES. called byinit_main.init_MANPODSβ determines if man pages should be generated and initializesMAN1PODSandMAN3PODSas appropriate.init_MAN1PODSβ initializesMAN1PODSfrom the list ofEXE_FILES.init_MAN3PODSβ initializesMAN3PODSfrom the list of PM files.init_PMβ initializesPMLIBDIRSandPMfromPMLIBDIRS.init_DIRFILESEPβ using/for Unix. called byinit_main.init_mainβ initializesAR,AR_STATIC_ARGS,BASEEXT,CONFIG,DISTNAME,DLBASE,EXE_EXT,FULLEXT,FULLPERL,FULLPERLRUN,FULLPERLRUNINST,INST_*,INSTALL*,INSTALLDIRS,LIB_EXT,LIBPERL_A,MAP_TARGET,NAME,OBJ_EXT,PARENT_NAME,PERL,PERL_ARCHLIB,PERL_INC,PERL_LIB,PERL_SRC,PERLRUN,PERLRUNINST,PREFIX,VERSION,VERSION_SYM,XS_VERSION.init_toolsβ initializes tools to use their common (and faster) Unix commands.init_linkerβ Unix has no need of special linker flags.init_PERLβ$mm->init_PERL;β called byinit_main. sets upABSPERL,PERL,FULLPERLand all the*PERLRUN*permutations:PERLis allowed to be miniperlFULLPERLmust be a complete perlABSPERLisPERLconverted to an absolute path*PERLRUNcontains everything necessary to run perl, find it's libraries, etc...*PERLRUNINSTis*PERLRUN+ everything necessary to find the modules being built.
init_platformplatform_constantsβ addMM_Unix_VERSION.init_PERMβ$mm->init_PERMβ called byinit_main. initializesPERL_*.init_xsβ$mm->init_xsβ sets up macros having to do with XS code. currently justINST_STATIC,INST_DYNAMICandINST_BOOT.install (o)β defines the install target.installbin (o)β defines targets to make and to installEXE_FILES.linkext (o)β defines thelinkexttarget which in turn defines theLINKTYPE.lsdirβ takes as arguments a directory name and a regular expression. returns all entries in the directory that match the regular expression.macro (o)β simple subroutine to insert the macros defined by the macro attribute into the Makefile.makeaperl (o)β called bystaticmake. defines how to write the Makefile to produce a static new perl. 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.aare automatically ignored to avoid link errors.)
πΈ xs_static_lib_is_xs (o)
Called by a utility method of makeaperl. It checks whether a given file is an XS library by seeing whether it defines any symbols starting with "boot_" β with an optional leading underscore, because MacOS needs that little extra π
.
π makefile (o)
Defines how to rewrite the Makefile. Thatβs the whole vibe.
π¦ maybe_command
Returns true if the argument is likely to be a command. Lowkey a vibe check for commands β¨.
π needs_linking (o)
Does this module need linking? It looks into subdirectory objects β see also has_link_code().
π parse_abstract
Parses a file and returns what you think is the ABSTRACT.
π parse_version
my $version = MM->parse_version($file);
Parse a $file and return what $VERSION is set to by the first assignment. It will return the string "undef" if it canβt figure out what $VERSION is. $VERSION should be for all to see, so "our $VERSION" or plain $VERSION are okay, but "my $VERSION" is not.
"package Foo VERSION" is also checked for. The first version declaration found is used, but this may change as it differs from how Perl does it.
parse_version() will try to use version before checking for $VERSION, so the following will work:
$VERSION = qv(1.2.3);
π§ pasthru (o)
Defines the string that is passed to recursive make calls in subdirectories. The variables like "PASTHRU_DEFINE" are used in each level, and passed downwards on the command-line with e.g. the value of that levelβs DEFINE. Example:
# Level 0 has DEFINE = -Dfunky
# This code will define level 0's PASTHRU=PASTHRU_DEFINE="$(DEFINE)
# $(PASTHRU_DEFINE)"
# Level 0's $(CCCMD) will include macros $(DEFINE) and $(PASTHRU_DEFINE)
# So will level 1's, so when level 1 compiles, it will get right values
# And so ad infinitum
π perl_script
Takes one argument, a file name, and returns the file name if the argument is likely to be a perl script. On MM_Unix this is true for any ordinary, readable file.
β¨ perldepend (o)
Defines the dependency from all *.h files that come with the perl distribution.
π pm_to_blib
Defines target that copies all files in the hash PM to their destination and autosplits them. See "DESCRIPTION" in ExtUtils::Install.
π¦ ppd
Defines target that creates a PPD (Perl Package Description) file for a binary distribution.
π prefixify
$MM->prefixify($var, $prefix, $new_prefix, $default);
Using either $MM->{uc $var} || $Config{lc $var}, it will attempt to replace its $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'.
π processPL (o)
Defines targets to run *.PL files.
π specify_shell
Specify SHELL if needed β not done on Unix.
π§ quote_paren
Backslashes parentheses "()" in command line arguments. Doesnβt handle recursive Makefile "$(...)" constructs, but handles simple ones.
π replace_manpage_separator
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.
β¨ cd
Just cd β thatβs the whole entry, bestie π
.
π oneliner
Just oneliner β no extra description in the source.
π¦ quote_literal
Quotes macro literal value suitable for being used on a command line so that when expanded by make, it will be received by command as given to this method:
my $quoted = $mm->quote_literal(q{it isn't});
# returns:
# 'it isn'\''t'
print MAKEFILE "target:\n\techo $quoted\n";
# when run "make target", will output:
# it isn't
π escape_newlines
Just escape_newlines β no extra description in the source.
π max_exec_len
Using POSIX::ARG_MAX. Otherwise falling back to 4096.
π static (o)
Defines the static target.
π§ xs_make_static_lib
Defines the recipes for the "static_lib" section.
π static_lib_closures
Records "$(EXTRALIBS)" in extralibs.ld and $(PERL_SRC)/ext.libs.
β¨ static_lib_fixtures
Handles copying $(MYEXTLIB) as starter for final static library that then gets added to.
π static_lib_pure_cmd
Defines how to run the archive utility.
π¦ staticmake (o)
Calls makeaperl.
π subdir_x (o)
Helper subroutine for subdirs.
π subdirs (o)
Defines targets to process subdirectories.
π test (o)
Defines the test targets.
π§ test_via_harness (override)
For some reason which I forget, Unix machines like to have PERL_DL_NONLAZY set for tests.
π test_via_script (override)
Again, the PERL_DL_NONLAZY thing.
β¨ tool_xsubpp (o)
Determines typemaps, xsubpp version, prototype behaviour.
π all_target
Build man pages, too.
π¦ top_targets (o)
Defines the targets all, subdirs, config, and O_FILES.
π writedoc
Obsolete, deprecated method. Not used since Version 5.21.
π xs_c (o)
Defines the suffix rules to compile XS files to C.
π xs_cpp (o)
Defines the suffix rules to compile XS files to C++.
π§ xs_o (o)
Defines suffix rules to go from XS to object files directly. This was originally only intended for broken make implementations, but is now necessary for per-XS file under "XSMULTI", since each XS file might have an individual "$(VERSION)".
π SEE ALSO π
ExtUtils::MakeMaker
π«Ά aaaand thatβs the whole page, bestie! This is fromExtUtils::MM_Unix(3)in perlv5.42.0, dated2023-04-04. Byeeee π β¨
π¦ where this page comes from
- opensuse-leap 16.0: perl-ExtUtils-MakeMaker 7.70-160000.2.2 Β· Artistic-1.0 OR GPL-1.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms