home *** CD-ROM | disk | FTP | other *** search
/ PC World 2005 December (Special) / PCWorld_2005-12_Special_cd.bin / Bezpecnost / lsti / lsti.exe / framework-2.5.exe / Build.pm < prev    next >
Text File  |  2005-04-27  |  69KB  |  1,911 lines
  1. package Module::Build;
  2.  
  3. # This module doesn't do much of anything itself, it inherits from the
  4. # modules that do the real work.  The only real thing it has to do is
  5. # figure out which OS-specific module to pull in.  Many of the
  6. # OS-specific modules don't do anything either - most of the work is
  7. # done in Module::Build::Base.
  8.  
  9. use strict;
  10. use File::Spec ();
  11. use File::Path ();
  12. use File::Basename ();
  13.  
  14. use Module::Build::Base;
  15.  
  16. use vars qw($VERSION @ISA);
  17. @ISA = qw(Module::Build::Base);
  18. $VERSION = '0.2610';
  19. $VERSION = eval $VERSION;
  20.  
  21. # Okay, this is the brute-force method of finding out what kind of
  22. # platform we're on.  I don't know of a systematic way.  These values
  23. # came from the latest (bleadperl) perlport.pod.
  24.  
  25. my %OSTYPES = qw(
  26.          aix       Unix
  27.          bsdos     Unix
  28.          dgux      Unix
  29.          dynixptx  Unix
  30.          freebsd   Unix
  31.          linux     Unix
  32.          hpux      Unix
  33.          irix      Unix
  34.          darwin    Unix
  35.          machten   Unix
  36.          next      Unix
  37.          openbsd   Unix
  38.          netbsd    Unix
  39.          dec_osf   Unix
  40.          svr4      Unix
  41.          svr5      Unix
  42.          sco_sv    Unix
  43.          unicos    Unix
  44.          unicosmk  Unix
  45.          solaris   Unix
  46.          sunos     Unix
  47.          cygwin    Unix
  48.          os2       Unix
  49.          
  50.          dos       Windows
  51.          MSWin32   Windows
  52.  
  53.          os390     EBCDIC
  54.          os400     EBCDIC
  55.          posix-bc  EBCDIC
  56.          vmesa     EBCDIC
  57.  
  58.          MacOS     MacOS
  59.          VMS       VMS
  60.          VOS       VOS
  61.          riscos    RiscOS
  62.          amigaos   Amiga
  63.          mpeix     MPEiX
  64.         );
  65.  
  66. sub _interpose_module {
  67.   my ($self, $mod) = @_;
  68.   eval "use $mod";
  69.   die $@ if $@;
  70.  
  71.   no strict 'refs';
  72.   my $top_class = $mod;
  73.   while (@{"${top_class}::ISA"}) {
  74.     last if ${"${top_class}::ISA"}[0] eq $ISA[0];
  75.     $top_class = ${"${top_class}::ISA"}[0];
  76.   }
  77.  
  78.   @{"${top_class}::ISA"} = @ISA;
  79.   @ISA = ($mod);
  80. }
  81.  
  82. if (grep {-e File::Spec->catfile($_, qw(Module Build Platform), $^O) . '.pm'} @INC) {
  83.   __PACKAGE__->_interpose_module("Module::Build::Platform::$^O");
  84.  
  85. } elsif (exists $OSTYPES{$^O}) {
  86.   __PACKAGE__->_interpose_module("Module::Build::Platform::$OSTYPES{$^O}");
  87.  
  88. } else {
  89.   warn "Unknown OS type '$^O' - using default settings\n";
  90. }
  91.  
  92. sub os_type { $OSTYPES{$^O} }
  93.  
  94. 1;
  95. __END__
  96.  
  97.  
  98. =head1 NAME
  99.  
  100. Module::Build - Build and install Perl modules
  101.  
  102. =head1 SYNOPSIS
  103.  
  104. Standard process for building & installing modules:
  105.  
  106.    perl Build.PL
  107.    ./Build
  108.    ./Build test
  109.    ./Build install
  110.  
  111. Or, if you're on a platform (like DOS or Windows) that doesn't like
  112. the "./" notation, you can do this:
  113.  
  114.    perl Build.PL
  115.    perl Build
  116.    perl Build test
  117.    perl Build install
  118.  
  119. =head1 DESCRIPTION
  120.  
  121. C<Module::Build> is a system for building, testing, and installing
  122. Perl modules.  It is meant to be an alternative to
  123. C<ExtUtils::MakeMaker>.  Developers may alter the behavior of the
  124. module through subclassing in a much more straightforward way than
  125. with C<MakeMaker>.  It also does not require a C<make> on your system
  126. - most of the C<Module::Build> code is pure-perl and written in a very
  127. cross-platform way.  In fact, you don't even need a shell, so even
  128. platforms like MacOS (traditional) can use it fairly easily.  Its only
  129. prerequisites are modules that are included with perl 5.6.0, and it
  130. works fine on perl 5.005 if you can install a few additional modules.
  131.  
  132. See L<"MOTIVATIONS"> for more comparisons between C<ExtUtils::MakeMaker>
  133. and C<Module::Build>.
  134.  
  135. To install C<Module::Build>, and any other module that uses
  136. C<Module::Build> for its installation process, do the following:
  137.  
  138.   perl Build.PL       # 'Build.PL' script creates the 'Build' script
  139.   ./Build             # Need ./ to ensure we're using this "Build" script
  140.   ./Build test        # and not another one that happens to be in the PATH
  141.   ./Build install
  142.  
  143. This illustrates initial configuration and the running of three
  144. 'actions'.  In this case the actions run are 'build' (the default
  145. action), 'test', and 'install'.  Other actions defined so far include:
  146.  
  147.   build                          fakeinstall 
  148.   config_data                    help        
  149.   clean                          html        
  150.   code                           install     
  151.   diff                           manifest    
  152.   dist                           ppd         
  153.   distcheck                      ppmdist     
  154.   distclean                      realclean   
  155.   distdir                        skipcheck   
  156.   distmeta                       test        
  157.   distsign                       testcover   
  158.   disttest                       testdb      
  159.   docs                           versioninstall
  160.  
  161. You can run the 'help' action for a complete list of actions.
  162.  
  163. When creating a C<Build.PL> script for a module, something like the
  164. following code will typically be used:
  165.  
  166.   use Module::Build;
  167.   my $build = Module::Build->new
  168.     (
  169.      module_name => 'Foo::Bar',
  170.      license => 'perl',
  171.      requires => {
  172.                   'perl'           => '5.6.1',
  173.                   'Some::Module'   => '1.23',
  174.                   'Other::Module'  => '>= 1.2, != 1.5, < 2.0',
  175.                  },
  176.     );
  177.   $build->create_build_script;
  178.  
  179. A simple module could get away with something as short as this for its
  180. C<Build.PL> script:
  181.  
  182.   use Module::Build;
  183.   Module::Build->new(
  184.      module_name => 'Foo::Bar',
  185.      license => 'perl',
  186.   )->create_build_script;
  187.  
  188. The model used by C<Module::Build> is a lot like the C<MakeMaker>
  189. metaphor, with the following correspondences:
  190.  
  191.    In Module::Build                 In ExtUtils::MakeMaker
  192.   ---------------------------      ------------------------
  193.    Build.PL (initial script)        Makefile.PL (initial script)
  194.    Build (a short perl script)      Makefile (a long Makefile)
  195.    _build/ (saved state info)       various config text in the Makefile
  196.  
  197. Any customization can be done simply by subclassing C<Module::Build>
  198. and adding a method called (for example) C<ACTION_test>, overriding
  199. the default 'test' action.  You could also add a method called
  200. C<ACTION_whatever>, and then you could perform the action C<Build
  201. whatever>.
  202.  
  203. For information on providing compatibility with
  204. C<ExtUtils::MakeMaker>, see L<Module::Build::Compat> and
  205. L<http://www.makemaker.org/wiki/index.cgi?ModuleBuildConversionGuide>.
  206.  
  207. =head1 METHODS
  208.  
  209. I list here some of the most important methods in C<Module::Build>.
  210. Normally you won't need to deal with these methods unless you want to
  211. subclass C<Module::Build>.  But since one of the reasons I created
  212. this module in the first place was so that subclassing is possible
  213. (and easy), I will certainly write more docs as the interface
  214. stabilizes.
  215.  
  216. =over 4
  217.  
  218. =item new()
  219.  
  220. Creates a new Module::Build object.  Arguments to the new() method are
  221. listed below.  Unless otherwise documented, there's also a
  222. corresponding get/set method on the C<Module::Build> object to access
  223. their values.  Most arguments are optional, but you must provide
  224. either the C<module_name> argument, or C<dist_name> and one of
  225. C<dist_version> or C<dist_version_from>.  In other words, you must
  226. provide enough information to determine both a distribution name and
  227. version.
  228.  
  229. =over 4
  230.  
  231. =item module_name
  232.  
  233. The C<module_name> is a shortcut for setting default values of
  234. C<dist_name> and C<dist_version_from>, reflecting the fact that the
  235. majority of CPAN distributions are centered around one "main" module.
  236. For instance, if you set C<module_name> to C<Foo::Bar>, then
  237. C<dist_name> will default to C<Foo-Bar> and C<dist_version_from> will
  238. default to C<lib/Foo/Bar.pm>.  C<dist_version_from> will in turn be
  239. used to set C<dist_version>.
  240.  
  241. Setting C<module_name> won't override a C<dist_*> parameter you
  242. specify explicitly.
  243.  
  244. =item dist_name
  245.  
  246. Specifies the name for this distribution.  Most authors won't need to
  247. set this directly, they can use C<module_name> to set C<dist_name> to
  248. a reasonable default.  However, some agglomerative distributions like
  249. C<libwww-perl> or C<bioperl> have names that don't correspond directly
  250. to a module name, so C<dist_name> can be set independently.
  251.  
  252. =item dist_version
  253.  
  254. Specifies a version number for the distribution.  See C<module_name>
  255. or C<dist_version_from> for ways to have this set automatically from a
  256. C<$VERSION> variable in a module.  One way or another, a version
  257. number needs to be set.
  258.  
  259. =item dist_version_from
  260.  
  261. Specifies a file to look for the distribution version in.  Most
  262. authors won't need to set this directly, they can use C<module_name>
  263. to set it to a reasonable default.
  264.  
  265. The version is extracted from the specified file according to the same
  266. rules as C<ExtUtils::MakeMaker> and C<CPAN.pm>.  It involves finding
  267. the first line that matches the regular expression
  268.  
  269.    /([\$*])(([\w\:\']*)\bVERSION)\b.*\=/
  270.  
  271. , eval()-ing that line, then checking the value of the C<$VERSION>
  272. variable.  Quite ugly, really, but all the modules on CPAN depend on
  273. this process, so there's no real opportunity to change to something
  274. better.
  275.  
  276. =item license
  277.  
  278. Specifies the licensing terms of your distribution.  Valid options include:
  279.  
  280. =over 4
  281.  
  282. =item perl
  283.  
  284. The distribution may be copied and redistributed under the same terms
  285. as perl itself (this is by far the most common licensing option for
  286. modules on CPAN).  This is a dual license, in which the user may
  287. choose between either the GPL or the Artistic license.
  288.  
  289. =item gpl
  290.  
  291. The distribution is distributed under the terms of the Gnu General
  292. Public License (http://www.opensource.org/licenses/gpl-license.php).
  293.  
  294. =item lgpl
  295.  
  296. The distribution is distributed under the terms of the Gnu Lesser
  297. General Public License
  298. (http://www.opensource.org/licenses/lgpl-license.php).
  299.  
  300. =item artistic
  301.  
  302. The distribution is licensed under the Artistic License, as specified
  303. by the F<Artistic> file in the standard perl distribution.
  304.  
  305. =item bsd
  306.  
  307. The distribution is licensed under the BSD License
  308. (http://www.opensource.org/licenses/bsd-license.php).
  309.  
  310. =item open_source
  311.  
  312. The distribution is licensed under some other Open Source
  313. Initiative-approved license listed at
  314. http://www.opensource.org/licenses/ .
  315.  
  316. =item unrestricted
  317.  
  318. The distribution is licensed under a license that is B<not> approved
  319. by www.opensource.org but that allows distribution without
  320. restrictions.
  321.  
  322. =item restrictive
  323.  
  324. The distribution may not be redistributed without special permission
  325. from the author and/or copyright holder.
  326.  
  327. =back
  328.  
  329. Note that you must still include the terms of your license in your
  330. documentation - this field only lets automated tools figure out your
  331. licensing restrictions.  Humans still need something to read.
  332.  
  333. It is a fatal error to use a license other than the ones mentioned
  334. above.  This is not because I wish to impose licensing terms on you -
  335. please let me know if you would like another license option to be
  336. added to the list.  You may also use a license type of C<unknown> if
  337. you don't wish to specify your terms (but this is usually not a good
  338. idea for you to do!).
  339.  
  340. I just started out with a small set of licenses to keep things simple,
  341. figuring I'd let people with actual working knowledge in this area
  342. tell me what to do.  So if that's you, drop me a line.
  343.  
  344. =item requires
  345.  
  346. An optional C<requires> argument specifies any module prerequisites that
  347. the current module depends on.  The prerequisites are given in a hash
  348. reference, where the keys are the module names and the values are
  349. version specifiers:
  350.  
  351.  requires => {Foo::Module => '2.4',
  352.               Bar::Module => 0,
  353.               Ken::Module => '>= 1.2, != 1.5, < 2.0',
  354.               perl => '5.6.0'},
  355.  
  356. These four version specifiers have different effects.  The value
  357. C<'2.4'> means that B<at least> version 2.4 of C<Foo::Module> must be
  358. installed.  The value C<0> means that B<any> version of C<Bar::Module>
  359. is acceptable, even if C<Bar::Module> doesn't define a version.  The
  360. more verbose value C<'E<gt>= 1.2, != 1.5, E<lt> 2.0'> means that
  361. C<Ken::Module>'s version must be B<at least> 1.2, B<less than> 2.0,
  362. and B<not equal to> 1.5.  The list of criteria is separated by commas,
  363. and all criteria must be satisfied.
  364.  
  365. A special C<perl> entry lets you specify the versions of the Perl
  366. interpreter that are supported by your module.  The same version
  367. dependency-checking semantics are available, except that we also
  368. understand perl's new double-dotted version numbers.
  369.  
  370. One note: currently C<Module::Build> doesn't actually I<require> the
  371. user to have dependencies installed, it just strongly urges.  In the
  372. future we may require it.  There's now a C<recommends> section for
  373. things that aren't absolutely required.
  374.  
  375. Automated tools like CPAN.pm should refuse to install a module if one
  376. of its dependencies isn't satisfied, unless a "force" command is given
  377. by the user.  If the tools are helpful, they should also offer to
  378. install the dependencies.
  379.  
  380. A sysnonym for C<requires> is C<prereq>, to help succour people
  381. transitioning from C<ExtUtils::MakeMaker>.  The C<requires> term is
  382. preferred, but the C<prereq> term will remain valid in future
  383. distributions.
  384.  
  385. =item recommends
  386.  
  387. This is just like the C<requires> argument, except that modules listed
  388. in this section aren't essential, just a good idea.  We'll just print
  389. a friendly warning if one of these modules aren't found, but we'll
  390. continue running.
  391.  
  392. If a module is recommended but not required, all tests should still
  393. pass if the module isn't installed.  This may mean that some tests
  394. will be skipped if recommended dependencies aren't present.
  395.  
  396. Automated tools like CPAN.pm should inform the user when recommended
  397. modules aren't installed, and it should offer to install them if it
  398. wants to be helpful.
  399.  
  400. =item build_requires
  401.  
  402. Modules listed in this section are necessary to build and install the
  403. given module, but are not necessary for regular usage of it.  This is
  404. actually an important distinction - it allows for tighter control over
  405. the body of installed modules, and facilitates correct dependency
  406. checking on binary/packaged distributions of the module.
  407.  
  408. =item conflicts
  409.  
  410. Modules listed in this section conflict in some serious way with the
  411. given module.  C<Module::Build> (or some higher-level tool) will
  412. refuse to install the given module if the given module/version is also
  413. installed.
  414.  
  415. =item create_makefile_pl
  416.  
  417. This parameter lets you use Module::Build::Compat during the
  418. C<distdir> (or C<dist>) action to automatically create a Makefile.PL
  419. for compatibility with ExtUtils::MakeMaker.  The parameter's value
  420. should be one of the styles named in the Module::Build::Compat
  421. documentation.
  422.  
  423. =item create_readme
  424.  
  425. This parameter tells Module::Build to automatically create a F<README>
  426. file at the top level of your distribution.  Currently it will simply
  427. use C<Pod::Text> on the file indicated by C<dist_version_from> and put
  428. the result in the F<README> file.  This is by no means the only
  429. recommended style for writing a README, but it seems to be one common
  430. one used on the CPAN.
  431.  
  432. =item create_packlist
  433.  
  434. If true, this parameter tells Module::Build to create a F<.packlist>
  435. file during the C<install> action, just like ExtUtils::MakeMaker does.
  436. The file is created in a subdirectory of the C<arch> installation
  437. location.  It is used by some other tools (CPAN, CPANPLUS, etc.) for
  438. determining what files are part of an install.
  439.  
  440. The default value is true.  This parameter was introduced in
  441. Module::Build version 0.2609; previously no packlists were ever
  442. created by Module::Build.
  443.  
  444. =item c_source
  445.  
  446. An optional C<c_source> argument specifies a directory which contains
  447. C source files that the rest of the build may depend on.  Any C<.c>
  448. files in the directory will be compiled to object files.  The
  449. directory will be added to the search path during the compilation and
  450. linking phases of any C or XS files.
  451.  
  452. =item pm_files
  453.  
  454. An optional parameter specifying the set of C<.pm> files in this
  455. distribution, specified as a hash reference whose keys are the files'
  456. locations in the distributions, and whose values are their logical
  457. locations based on their package name, i.e. where they would be found
  458. in a "normal" Module::Build-style distribution.  This parameter is
  459. mainly intended to support alternative layouts of files.
  460.  
  461. For instance, if you have an old-style MakeMaker distribution for a
  462. module called C<Foo::Bar> and a F<Bar.pm> file at the top level of the
  463. distribution, you could specify your layout in your C<Build.PL> like
  464. this:
  465.  
  466.  my $build = Module::Build->new
  467.    ( module_name => 'Foo::Bar',
  468.      ...
  469.      pm_files => { 'Bar.pm' => 'lib/Foo/Bar.pm' },
  470.    );
  471.  
  472. Note that the values should include C<lib/>, because this is where
  473. they would be found in a "normal" Module::Build-style distribution.
  474.  
  475. Note also that the path specifications are I<always> given in
  476. Unix-like format, not in the style of the local system.
  477.  
  478. =item pod_files
  479.  
  480. Just like C<pm_files>, but used for specifying the set of C<.pod>
  481. files in your distribution.
  482.  
  483. =item xs_files
  484.  
  485. Just like C<pm_files>, but used for specifying the set of C<.xs>
  486. files in your distribution.
  487.  
  488. =item PL_files
  489.  
  490. An optional parameter specifying a set of C<.PL> files in your
  491. distribution.  These will be run as Perl scripts prior to processing
  492. the rest of the files in your distribution.  They are usually used as
  493. templates for creating other files dynamically, so that a file like
  494. C<lib/Foo/Bar.pm.PL> might create the file C<lib/Foo/Bar.pm>.
  495.  
  496. The files are specified with the C<.PL> files as hash keys, and the
  497. file(s) they generate as hash values, like so:
  498.  
  499.  my $build = Module::Build->new
  500.    ( module_name => 'Foo::Bar',
  501.      ...
  502.      PL_files => { 'lib/Bar.pm.PL' => 'lib/Bar.pm',
  503.                    'lib/Foo.PL' => [ 'lib/Foo1.pm', 'lib/Foo2.pm' ],
  504.                  },
  505.    );
  506.  
  507. Note that the path specifications are I<always> given in Unix-like
  508. format, not in the style of the local system.
  509.  
  510. =item script_files
  511.  
  512. An optional parameter specifying a set of files that should be
  513. installed as executable perl scripts when the module is installed.
  514. May be given as an array reference of the files, or as a hash
  515. reference whose keys are the files (and whose values will currently be
  516. ignored).
  517.  
  518. The default is to install no script files - in other words, there is
  519. no default location where Module::Build will look for script files to
  520. install.
  521.  
  522. For backward compatibility, you may use the parameter C<scripts>
  523. instead of C<script_files>.  Please consider this usage deprecated,
  524. though it will continue to exist for several version releases.
  525.  
  526. =item test_files
  527.  
  528. An optional parameter specifying a set of files that should be used as
  529. C<Test::Harness>-style regression tests to be run during the C<test>
  530. action.  May be given as an array reference of the files, or as a hash
  531. reference whose keys are the files (and whose values will currently be
  532. ignored).  If the argument is given as a single string (not in an
  533. array reference), that string will be treated as a C<glob()> pattern
  534. specifying the files to use.
  535.  
  536. The default is to look for a F<test.pl> script in the top-level
  537. directory of the distribution, and any files matching the glob pattern
  538. C<*.t> in the F<t/> subdirectory.  If the C<recursive_test_files>
  539. property is true, then the C<t/> directory will be scanned recursively
  540. for C<*.t> files.
  541.  
  542. =item autosplit
  543.  
  544. An optional C<autosplit> argument specifies a file which should be run
  545. through the C<Autosplit::autosplit()> function.  If multiple files
  546. should be split, the argument may be given as an array of the files to
  547. split.
  548.  
  549. In general I don't consider autosplitting a great idea, because it's
  550. not always clear that
  551. autosplitting achieves its intended performance benefits.  It may even
  552. harm performance in environments like mod_perl, where as much as
  553. possible of a module's code should be loaded during startup.
  554.  
  555. =item dynamic_config
  556.  
  557. A boolean flag indicating whether the F<Build.PL> file must be
  558. executed, or whether this module can be built, tested and installed
  559. solely from consulting its metadata file.  The default value is 0,
  560. reflecting the fact that "most" of the modules on CPAN just need to be
  561. copied from one place to another.  The main reason to set this to a
  562. true value is that your module performs some dynamic configuration as
  563. part of its build/install process.
  564.  
  565. Currently C<Module::Build> doesn't actually do anything with this flag
  566. - it's probably going to be up to tools like C<CPAN.pm> to do
  567. something useful with it.  It can potentially bring lots of security,
  568. packaging, and convenience improvements.
  569.  
  570. =item add_to_cleanup
  571.  
  572. An array reference of files to be cleaned up when the C<clean> action
  573. is performed.  See also the add_to_cleanup() method.
  574.  
  575. =item sign
  576.  
  577. If a true value is specified for this parameter, C<Module::Signature>
  578. will be used (via the 'distsign' action) to create a SIGNATURE file
  579. for your distribution during the 'distdir' action, and to add the
  580. SIGNATURE file to the MANIFEST (therefore, don't add it yourself).
  581.  
  582. The default value is false.  In the future, the default may change to
  583. true if you have C<Module::Signature> installed on your system.
  584.  
  585. =item extra_compiler_flags
  586.  
  587. =item extra_linker_flags
  588.  
  589. These parameters can contain array references (or strings, in which
  590. case they will be split into arrays) to pass through to the compiler
  591. and linker phases when compiling/linking C code.  For example, to tell
  592. the compiler that your code is C++, you might do:
  593.  
  594.  my build = Module::Build->new(
  595.      module_name          => 'Spangly',
  596.      extra_compiler_flags => ['-x', 'c++'],
  597.  );
  598.  
  599. To link your XS code against glib you might write something like:
  600.  
  601.  my build = Module::Build->new(
  602.      module_name          => 'Spangly',
  603.      dynamic_config       => 1,
  604.      extra_compiler_flags => scalar `glib-config --cflags`,
  605.      extra_linker_flags   => scalar `glib-config --libs`,
  606.  );
  607.  
  608. =item include_dirs
  609.  
  610. Specifies any additional directories in which to search for C header
  611. files.  May be given as a string indicating a single directory, or as
  612. a list reference indicating multiple directories.
  613.  
  614.  
  615. =item dist_author
  616.  
  617. This should be something like "John Doe <jdoe@example.com>", or if
  618. there are multiple authors, an anonymous array of strings may be
  619. specified.  This is used when generating metadata for F<META.yml> and
  620. PPD files.  If this is not specified, then C<Module::Build> looks at
  621. the module from which it gets the distribution's version.  If it finds
  622. a POD section marked "=head1 AUTHOR", then it uses the contents of
  623. this section.
  624.  
  625. =item dist_abstract
  626.  
  627. This should be a short description of the distribution.  This is used
  628. when generating metadata for F<META.yml> and PPD files.  If it is not
  629. given then C<Module::Build> looks in the POD of the module from which
  630. it gets the distribution's version.  It looks for the first line
  631. matching C<$package\s-\s(.+)>, and uses the captured text as the
  632. abstract.
  633.  
  634. =item auto_features
  635.  
  636. This parameter supports the setting of features (see
  637. L<feature($name)>) automatically based on a set of prerequisites.  For
  638. instance, for a module that could optionally use either MySQL or
  639. PostgreSQL databases, you might use C<auto_features> like this:
  640.  
  641.   my $b = Module::Build->new
  642.     (
  643.      ... other stuff here...
  644.      auto_features =>
  645.        {
  646.         pg_support =>
  647.         {
  648.            description => "Interface with Postgres databases",
  649.            requires => q{ DBD::Pg >= 23.3 && DateTime::Format::Pg },
  650.         },
  651.         mysql_support =>
  652.         {
  653.            description => "Interface with MySQL databases",
  654.            requires => q{ DBD::mysql >= 17.9 && DateTime::Format::Pg },
  655.         },
  656.      );
  657.  
  658. For each feature named, the prerequisite options will be checked, and
  659. if there are no failures, the feature will be enabled (set to C<1>).
  660. Otherwise the failures will be displayed to the user and the feature
  661. will be disabled (set to C<0>).
  662.  
  663. =item get_options
  664.  
  665. You can pass arbitrary command-line options to F<Build.PL> or F<Build>, and they will be
  666. stored in the Module::Build object and can be accessed via the C<args()>
  667. method. However, sometimes you want more flexibility out of your argument
  668. processing than this allows. In such cases, use the C<get_options> parameter
  669. to pass in a hash reference of argument specifications, and the list of
  670. arguments to F<Build.PL> or F<Build> will be processed according to those
  671. specifications before they're passed on to C<Module::Build>'s own argument
  672. processing.
  673.  
  674. The supported option specification hash keys are:
  675.  
  676. =over 4
  677.  
  678. =item type
  679.  
  680. The type of option. The types are those supported by Getopt::Long; consult
  681. its documentation for a complete list. Typical types are C<=s> for strings,
  682. C<+> for additive options, and C<!> for negatable options.  If the
  683. type is not specified, it will be considered a boolean, i.e. no
  684. argument is taken and a value of 1 will be assigned when the option is
  685. encountered.
  686.  
  687. =item store
  688.  
  689. A reference to a scalar in which to store the value passed to the option.
  690. If not specified, the value will be stored under the option name in the
  691. hash returned by the C<args()> method.
  692.  
  693. =item default
  694.  
  695. A default value for the option. If no default value is specified and no option
  696. is passed, then the option key will not exist in the hash returned by
  697. C<args()>.
  698.  
  699. =back
  700.  
  701. You can combine references to your own variables or subroutines with
  702. unreferenced specifications, for which the result will also be stored in the
  703. has returned by C<args()>. For example:
  704.  
  705.  my $loud = 0;
  706.  my $build = Module::Build->new(
  707.      module_name => 'Spangly',
  708.      get_options => {
  709.                       loud =>     { store => \$loud },
  710.                       dbd  =>     { type  => '=s'   },
  711.                       quantity => { type  => '+'    },
  712.                     }
  713.  );
  714.  
  715.  print STDERR "HEY, ARE YOU LISTENING??\n" if $loud;
  716.  print "We'll use the ", $build->args('dbd'), " DBI driver\n";
  717.  print "Are you sure you want that many?\n"
  718.    if $build->args('quantity') > 2;
  719.  
  720. The arguments for such a specification can be called like so:
  721.  
  722.  % perl Build.PL --loud --dbd=DBD::pg --quantity --quantity --quantity
  723.  
  724. B<WARNING:> Any option specifications that conflict with Module::Build's own
  725. options (defined by its properties) will throw an exception.
  726.  
  727. Consult the Getopt::Long documentation for details on its usage.
  728.  
  729. =back
  730.  
  731. =item args()
  732.  
  733.   my $args_href = $build->args;
  734.   my %args = $build->args;
  735.   my $arg_value = $build->args($key);
  736.   $build->args($key, $value);
  737.  
  738. This method is the preferred interface for retreiving the arguments passed via
  739. command-line options to F<Build.PL> or F<Build>, minus the Module-Build
  740. specific options.
  741.  
  742. When called in in a scalar context with no arguments, this method returns a
  743. reference to the hash storing all of the arguments; in an array context, it
  744. returns the hash itself. When passed a single argument, it returns the value
  745. stored in the args hash for that option key. When called with two arguments,
  746. the second argument is assigned to the args hash under the key passed as the
  747. first argument.
  748.  
  749. =item subclass()
  750.  
  751. This creates a new C<Module::Build> subclass on the fly, as described
  752. in the L<"SUBCLASSING"> section.  The caller must provide either a
  753. C<class> or C<code> parameter, or both.  The C<class> parameter
  754. indicates the name to use for the new subclass, and defaults to
  755. C<MyModuleBuilder>.  The C<code> parameter specifies Perl code to use
  756. as the body of the subclass.
  757.  
  758. =item create_build_script()
  759.  
  760. Creates an executable script called C<Build> in the current directory
  761. that will be used to execute further user actions.  This script is
  762. roughly analogous (in function, not in form) to the Makefile created
  763. by C<ExtUtils::MakeMaker>.  This method also creates some temporary
  764. data in a directory called C<_build/>.  Both of these will be removed
  765. when the C<realclean> action is performed.
  766.  
  767. =item add_to_cleanup(@files)
  768.  
  769. You may call C<< $self->add_to_cleanup(@patterns) >> to tell
  770. C<Module::Build> that certain files should be removed when the user
  771. performs the C<Build clean> action.  The arguments to the method are
  772. patterns suitable for passing to Perl's C<glob()> function, specified
  773. in either Unix format or the current machine's native format.  It's
  774. usually convenient to use Unix format when you hard-code the filenames
  775. (e.g. in F<Build.PL>) and the native format when the names are
  776. programmatically generated (e.g. in a testing script).
  777.  
  778. I decided to provide a dynamic method of the C<$build> object, rather
  779. than just use a static list of files named in the F<Build.PL>, because
  780. these static lists can get difficult to manage.  I usually prefer to
  781. keep the responsibility for registering temporary files close to the
  782. code that creates them.
  783.  
  784. =item new_from_context(%args)
  785.  
  786. When called from a directory containing a F<Build.PL> script and a
  787. F<META.yml> file (in other words, the base directory of a
  788. distribution), this method will run the F<Build.PL> and return the
  789. resulting C<Module::Build> object to the caller.  Any key-value
  790. arguments given to C<new_from_context()> are essentially like
  791. command-line arguments given to the F<Build.PL> script, so for example
  792. you could pass C<< verbose => 1 >> to this method to turn on
  793. verbosity.
  794.  
  795. =item resume()
  796.  
  797. You'll probably never call this method directly, it's only called from
  798. the auto-generated C<Build> script.  The C<new()> method is only
  799. called once, when the user runs C<perl Build.PL>.  Thereafter, when
  800. the user runs C<Build test> or another action, the C<Module::Build>
  801. object is created using the C<resume()> method to reinstantiate with
  802. the settings given earlier to C<new()>.
  803.  
  804. =item current()
  805.  
  806. This method returns a reasonable faxsimile of the currently-executing
  807. C<Module::Build> object representing the current build.  You can use
  808. this object to query its C<notes()> method, inquire about installed
  809. modules, and so on.  This is a great way to share information between
  810. different parts of your build process.  For instance, you can ask
  811. the user a question during C<perl Build.PL>, then use their answer
  812. during a regression test:
  813.  
  814.  # In Build.PL:
  815.  my $color = $build->prompt("What is your favorite color?");
  816.  $build->notes(color => $color);
  817.  
  818.  # In t/colortest.t:
  819.  use Module::Build;
  820.  my $build = Module::Build->current;
  821.  my $color = $build->notes('color');
  822.  ...
  823.  
  824. The way the C<current()> method is currently implemented, there may be
  825. slight differences between the C<$build> object in Build.PL and the
  826. one in C<t/colortest.t>.  It is our goal to minimize these differences
  827. in future releases of Module::Build, so please report any anomalies
  828. you find.
  829.  
  830. One important caveat: in its current implementation, C<current()> will
  831. B<NOT> work correctly if you have changed out of the directory that
  832. C<Module::Build> was invoked from.
  833.  
  834. =item notes()
  835.  
  836. =item notes($key)
  837.  
  838. =item notes($key => $value)
  839.  
  840. The C<notes()> value allows you to store your own persistent
  841. information about the build, and to share that information among
  842. different entities involved in the build.  See the example in the
  843. C<current()> method.
  844.  
  845. The C<notes()> method is essentally a glorified hash access.  With no
  846. arguments, C<notes()> returns a reference to the entire hash of notes.
  847. With one argument, C<notes($key)> returns the value associated with
  848. the given key.  With two arguments, C<notes($key, $value)> sets the
  849. value associated with the given key to C<$value>.
  850.  
  851. The lifetime of the C<notes> data is for "a build" - that is, the
  852. C<notes> hash is created when C<perl Build.PL> is run (or when the
  853. C<new()> method is run, if the Module::Build Perl API is being used
  854. instead of called from a shell), and lasts until C<perl Build.PL> is
  855. run again or the C<clean> action is run.
  856.  
  857. =item config()
  858.  
  859. Returns a hash reference containing the C<Config.pm> hash, including
  860. any changes the author or user has specified.  This is a reference to
  861. the actual internal hash we use, so you probably shouldn't modify
  862. stuff there.
  863.  
  864. =item dispatch($action, %args)
  865.  
  866. This method is also called from the auto-generated C<Build> script.
  867. It parses the command-line arguments into an action and an argument
  868. list, then calls the appropriate routine to handle the action.
  869. Currently (though this may change), an action C<foo> will invoke the
  870. C<ACTION_foo> method.  All arguments (including everything mentioned
  871. in L<"ACTIONS"> below) are contained in the C<< $self->{args} >> hash
  872. reference.
  873.  
  874. =item os_type()
  875.  
  876. If you're subclassing Module::Build and some code needs to alter its
  877. behavior based on the current platform, you may only need to know
  878. whether you're running on Windows, Unix, MacOS, VMS, etc. and not the
  879. fine-grained value of Perl's C<$^O> variable.  The C<os_type()> method
  880. will return a string like C<Windows>, C<Unix>, C<MacOS>, C<VMS>, or
  881. whatever is appropriate.  If you're running on an unknown platform, it
  882. will return C<undef> - there shouldn't be many unknown platforms
  883. though.
  884.  
  885. =item prereq_failures()
  886.  
  887. Returns a data structure containing information about any failed
  888. prerequisites (of any of the types described above), or C<undef> if
  889. all prerequisites are met.
  890.  
  891. The data structure returned is a hash reference.  The top level keys
  892. are the type of prerequisite failed, one of "requires",
  893. "build_requires", "conflicts", or "recommends".  The associated values
  894. are hash references whose keys are the names of required (or
  895. conflicting) modules.  The associated values of those are hash
  896. references indicating some information about the failure.  For example:
  897.  
  898.  {
  899.   have => '0.42',
  900.   need => '0.59',
  901.   message => 'Version 0.42 is installed, but we need version 0.59',
  902.  }
  903.  
  904. or
  905.  
  906.  {
  907.   have => '<none>',
  908.   need => '0.59',
  909.   message => 'Prerequisite Foo isn't installed',
  910.  }
  911.  
  912. This hash has the same structure as the hash returned by the
  913. C<check_installed_status()> method, except that in the case of
  914. "conflicts" dependencies we change the "need" key to "conflicts" and
  915. construct a proper message.
  916.  
  917. Examples:
  918.  
  919.   # Check a required dependency on Foo::Bar
  920.   if ( $m->prereq_failures->{requires}{Foo::Bar} ) { ...
  921.  
  922.   # Check whether there were any failures
  923.   if ( $m->prereq_failures ) { ...
  924.   
  925.   # Show messages for all failures
  926.   my $failures = $m->prereq_failures;
  927.   while (my ($type, $list) = each %$failures) {
  928.     while (my ($name, $hash) = each %$list) {
  929.       print "Failure for $name: $hash->{message}\n";
  930.     }
  931.   }
  932.  
  933. =item requires()
  934.  
  935. =item build_requires()
  936.  
  937. =item recommends()
  938.  
  939. =item conflicts()
  940.  
  941. Each of these methods returns a hash reference indicating the
  942. prerequisites that were passed to the C<new()> method.
  943.  
  944. =item check_installed_status($module, $version)
  945.  
  946. This method returns a hash reference indicating whether a version
  947. dependency on a certain module is satisfied.  The C<$module> argument
  948. is given as a string like C<"Data::Dumper"> or C<"perl">, and the
  949. C<$version> argument can take any of the forms described in L<requires>
  950. above.  This allows very fine-grained version checking.
  951.  
  952. The returned hash reference has the following structure:
  953.  
  954.  {
  955.   ok => $whether_the_dependency_is_satisfied,
  956.   have => $version_already_installed,
  957.   need => $version_requested, # Same as incoming $version argument
  958.   message => $informative_error_message,
  959.  }
  960.  
  961. If no version of C<$module> is currently installed, the C<have> value
  962. will be the string C<< "<none>" >>.  Otherwise the C<have> value will
  963. simply be the version of the installed module.  Note that this means
  964. that if C<$module> is installed but doesn't define a version number,
  965. the C<have> value will be C<undef> - this is why we don't use C<undef>
  966. for the case when C<$module> isn't installed at all.
  967.  
  968. This method may be called either as an object method
  969. (C<< $build->check_installed_status($module, $version) >>)
  970. or as a class method 
  971. (C<< Module::Build->check_installed_status($module, $version) >>).
  972.  
  973. =item check_installed_version($module, $version)
  974.  
  975. Like C<check_installed_status()>, but simply returns true or false
  976. depending on whether module C<$module> statisfies the dependency
  977. C<$version>.
  978.  
  979. If the check succeeds, the return value is the actual version of
  980. C<$module> installed on the system.  This allows you to do the
  981. following:
  982.  
  983.  my $installed = $m->check_installed_version('DBI', '1.15');
  984.  if ($installed) {
  985.    print "Congratulations, version $installed of DBI is installed.\n";
  986.  } else {
  987.    die "Sorry, you must install DBI.\n";
  988.  }
  989.  
  990. If the check fails, we return false and set C<$@> to an informative
  991. error message.
  992.  
  993. If C<$version> is any nontrue value (notably zero) and any version of
  994. C<$module> is installed, we return true.  In this case, if C<$module>
  995. doesn't define a version, or if its version is zero, we return the
  996. special value "0 but true", which is numerically zero, but logically
  997. true.
  998.  
  999. In general you might prefer to use C<check_installed_status> if you
  1000. need detailed information, or this method if you just need a yes/no
  1001. answer.
  1002.  
  1003. =item prompt($message, $default)
  1004.  
  1005. Asks the user a question and returns their response as a string.  The
  1006. first argument specifies the message to display to the user (for
  1007. example, C<"Where do you keep your money?">).  The second argument,
  1008. which is optional, specifies a default answer (for example,
  1009. C<"wallet">).  The user will be asked the question once.
  1010.  
  1011. If the current session doesn't seem to be interactive (i.e. if
  1012. C<STDIN> and C<STDOUT> look like they're attached to files or
  1013. something, not terminals), we'll just use the default without
  1014. letting the user provide an answer.
  1015.  
  1016. This method may be called as a class or object method.
  1017.  
  1018. =item y_n($message, $default)
  1019.  
  1020. Asks the user a yes/no question using C<prompt()> and returns true or
  1021. false accordingly.  The user will be asked the question repeatedly
  1022. until they give an answer that looks like "yes" or "no".
  1023.  
  1024. The first argument specifies the message to display to the user (for
  1025. example, C<"Shall I invest your money for you?">), and the second
  1026. argument specifies the default answer (for example, C<"y">).
  1027.  
  1028. Note that the default is specified as a string like C<"y"> or C<"n">,
  1029. and the return value is a Perl boolean value like 1 or 0.  I thought
  1030. about this for a while and this seemed like the most useful way to do
  1031. it.
  1032.  
  1033. This method may be called as a class or object method.
  1034.  
  1035. =item script_files()
  1036.  
  1037. Returns a hash reference whose keys are the perl script files to be
  1038. installed, if any.  This corresponds to the C<script_files> parameter to the
  1039. C<new()> method.  With an optional argument, this parameter may be set
  1040. dynamically.
  1041.  
  1042. For backward compatibility, the C<scripts()> method does exactly the
  1043. same thing as C<script_files()>.  C<scripts()> is deprecated, but it
  1044. will stay around for several versions to give people time to
  1045. transition.
  1046.  
  1047. =item add_build_element($type)
  1048.  
  1049. Adds a new type of entry to the build process.  Accepts a single
  1050. string specifying its type-name.  There must also be a method defined
  1051. to process things of that type, e.g. if you add a build element called
  1052. C<'foo'>, then you must also define a method called
  1053. C<process_foo_files()>.
  1054.  
  1055. See also L<Module::Build::Cookbook/Adding new elements to the build process>.
  1056.  
  1057. =item copy_if_modified(%parameters)
  1058.  
  1059. Takes the file in the C<from> parameter and copies it to the file in
  1060. the C<to> parameter, or the directory in the C<to_dir> parameter, if
  1061. the file has changed since it was last copied (or if it doesn't exist
  1062. in the new location).  By default the entire directory structure of
  1063. C<from> will be copied into C<to_dir>; an optional C<flatten>
  1064. parameter will copy into C<to_dir> without doing so.
  1065.  
  1066. Returns the path to the destination file, or C<undef> if nothing
  1067. needed to be copied.
  1068.  
  1069. Any directories that need to be created in order to perform the
  1070. copying will be automatically created.
  1071.  
  1072. =item do_system($cmd, @args)
  1073.  
  1074. This is a fairly simple wrapper around Perl's C<system()> built-in
  1075. command.  Given a command and an array of optional arguments, this
  1076. method will print the command to C<STDOUT>, and then execute it using
  1077. Perl's C<system()>.  It returns true or false to indicate success or
  1078. failure (the opposite of how C<system()> works, but more intuitive).
  1079.  
  1080. Note that if you supply a single argument to C<do_system()>, it
  1081. will/may be processed by the systems's shell, and any special
  1082. characters will do their special things.  If you supply multiple
  1083. arguments, no shell will get involved and the command will be executed
  1084. directly.
  1085.  
  1086. =item have_c_compiler()
  1087.  
  1088. Returns true if the current system seems to have a working C compiler.
  1089. We currently determine this by attempting to compile a simple C source
  1090. file and reporting whether the attempt was successful.
  1091.  
  1092. =item base_dir()
  1093.  
  1094. Returns a string containing the root-level directory of this build,
  1095. i.e. where the C<Build.PL> script and the C<lib> directory can be
  1096. found.  This is usually the same as the current working directory,
  1097. because the C<Build> script will C<chdir()> into this directory as
  1098. soon as it begins execution.
  1099.  
  1100. =item dist_name()
  1101.  
  1102. Returns the name of the current distribution, as passed to the
  1103. C<new()> method in a C<dist_name> or modified C<module_name>
  1104. parameter.
  1105.  
  1106. =item dist_version()
  1107.  
  1108. Returns the version of the current distribution, as determined by the
  1109. C<new()> method from a C<dist_version>, C<dist_version_from>, or
  1110. C<module_name> parameter.
  1111.  
  1112. =item up_to_date($source_file, $derived_file)
  1113.  
  1114. =item up_to_date(\@source_files, \@derived_files)
  1115.  
  1116. This method can be used to compare a set of source files to a set of
  1117. derived files.  If any of the source files are newer than any of the
  1118. derived files, it returns false.  Additionally, if any of the derived
  1119. files do not exist, it returns false.  Otherwise it returns true.
  1120.  
  1121. The arguments may be either a scalar or an array reference of file
  1122. names.
  1123.  
  1124. =item contains_pod($file)
  1125.  
  1126. Returns true if the given file appears to contain POD documentation.
  1127. Currently this checks whether the file has a line beginning with
  1128. '=pod', '=head', or '=item', but the exact semantics may change in the
  1129. future.
  1130.  
  1131. =item feature($name)
  1132.  
  1133. =item feature($name => $value)
  1134.  
  1135. With a single argument, returns true if the given feature is set.
  1136. With two arguments, sets the given feature to the given boolean value.
  1137. In this context, a "feature" is any optional functionality of an
  1138. installed module.  For instance, if you write a module that could
  1139. optionally support a MySQL or PostgreSQL backend, you might create
  1140. features called C<mysql_support> and C<postgres_support>, and set them
  1141. to true/false depending on whether the user has the proper databases
  1142. installed and configured.
  1143.  
  1144. Features set in this way using the Module::Build object will be
  1145. available for querying during the build/test process and after
  1146. installation via the generated C<...::ConfigData> module, as 
  1147. C<< ...::ConfigData->feature($name) >>.
  1148.  
  1149. The C<feature()> and C<config_data()> methods represent
  1150. Module::Build's main support for configuration of installed modules.
  1151. See also L<SAVING CONFIGURATION INFORMATION>.
  1152.  
  1153. =item config_data($name)
  1154.  
  1155. =item config_data($name => $value)
  1156.  
  1157. With a single argument, returns the value of the configuration
  1158. variable C<$name>.  With two arguments, sets the given configuration
  1159. variable to the given value.  The value may be any perl scalar that's
  1160. serializable with C<Data::Dumper>.  For instance, if you write a
  1161. module that can use a MySQL or PostgreSQL backend, you might create
  1162. configuration variables called C<mysql_connect> and
  1163. C<postgres_connect>, and set each to an array of connection parameters
  1164. for C<< DBI->connect() >>.
  1165.  
  1166. Configuration values set in this way using the Module::Build object
  1167. will be available for querying during the build/test process and after
  1168. installation via the generated C<...::ConfigData> module, as 
  1169. C<< ...::ConfigData->config($name) >>.
  1170.  
  1171. The C<feature()> and C<config_data()> methods represent
  1172. Module::Build's main support for configuration of installed modules.
  1173. See also L<SAVING CONFIGURATION INFORMATION>.
  1174.  
  1175.  
  1176. =back
  1177.  
  1178. =head1 ACTIONS
  1179.  
  1180. There are some general principles at work here.  First, each task when
  1181. building a module is called an "action".  These actions are listed
  1182. above; they correspond to the building, testing, installing,
  1183. packaging, etc. tasks.
  1184.  
  1185. Second, arguments are processed in a very systematic way.  Arguments
  1186. are always key=value pairs.  They may be specified at C<perl Build.PL>
  1187. time (i.e.  C<perl Build.PL destdir=/my/secret/place>), in which case
  1188. their values last for the lifetime of the C<Build> script.  They may
  1189. also be specified when executing a particular action (i.e.
  1190. C<Build test verbose=1>), in which case their values last only for the
  1191. lifetime of that command.  Per-action command-line parameters take
  1192. precedence over parameters specified at C<perl Build.PL> time.
  1193.  
  1194. The build process also relies heavily on the C<Config.pm> module, and
  1195. all the key=value pairs in C<Config.pm> are available in 
  1196.  
  1197. C<< $self->{config} >>.  If the user wishes to override any of the
  1198. values in C<Config.pm>, she may specify them like so:
  1199.  
  1200.   perl Build.PL --config cc=gcc --config ld=gcc
  1201.  
  1202. The following build actions are provided by default.
  1203.  
  1204. =over 4
  1205.  
  1206. =item help
  1207.  
  1208. This action will simply print out a message that is meant to help you
  1209. use the build process.  It will show you a list of available build
  1210. actions too.
  1211.  
  1212. With an optional argument specifying an action name (e.g. C<Build help
  1213. test>), the 'help' action will show you any POD documentation it can
  1214. find for that action.
  1215.  
  1216. =item build
  1217.  
  1218. If you run the C<Build> script without any arguments, it runs the
  1219. C<build> action, which in turn runs the C<code> and C<docs> actions.
  1220.  
  1221. This is analogous to the MakeMaker 'make all' target.
  1222.  
  1223. =item code
  1224.  
  1225. This action builds your codebase.
  1226.  
  1227. By default it just creates a C<blib/> directory and copies any C<.pm>
  1228. and C<.pod> files from your C<lib/> directory into the C<blib/>
  1229. directory.  It also compiles any C<.xs> files from C<lib/> and places
  1230. them in C<blib/>.  Of course, you need a working C compiler (probably
  1231. the same one that built perl itself) for the compilation to work
  1232. properly.
  1233.  
  1234. The C<build> action also runs any C<.PL> files in your F<lib/>
  1235. directory.  Typically these create other files, named the same but
  1236. without the C<.PL> ending.  For example, a file F<lib/Foo/Bar.pm.PL>
  1237. could create the file F<lib/Foo/Bar.pm>.  The C<.PL> files are
  1238. processed first, so any C<.pm> files (or other kinds that we deal
  1239. with) will get copied correctly.
  1240.  
  1241. If your C<.PL> scripts don't create any files, or if they create files
  1242. with unexpected names, or even if they create multiple files, you
  1243. should tell us that so that we can clean up properly after these
  1244. created files.  Use the C<PL_files> parameter to C<new()>:
  1245.  
  1246.  PL_files => { 'lib/Foo/Bar_pm.PL' => 'lib/Foo/Bar.pm',
  1247.                'lib/something.PL'  => ['/lib/something', '/lib/else'],
  1248.                'lib/funny.PL'      => [] }
  1249.  
  1250. Note that in contrast to MakeMaker, the C<build> action only
  1251. (currently) handles C<.pm>, C<.pod>, C<.PL>, and C<.xs> files.  They
  1252. must all be in the C<lib/> directory, in the directory structure that
  1253. they should have when installed.  We also handle C<.c> files that can
  1254. be in the place of your choosing - see the C<c_source> argument to
  1255. C<new()>.
  1256.  
  1257. The C<.xs> support is currently in alpha.  Please let me know whether
  1258. it works for you.
  1259.  
  1260. =item docs
  1261.  
  1262. This will generate documentation (ie: Unix man pages) for any binary and
  1263. library files under B<blib/> that contain POD.  If there are no C<bindoc> or
  1264. C<libdoc> installation targets defined (as will be the case on systems that
  1265. don't support Unix manpages) this action does nothing.
  1266.  
  1267. =item test
  1268.  
  1269. This will use C<Test::Harness> to run any regression tests and report
  1270. their results.  Tests can be defined in the standard places: a file
  1271. called C<test.pl> in the top-level directory, or several files ending
  1272. with C<.t> in a C<t/> directory.
  1273.  
  1274. If you want tests to be 'verbose', i.e. show details of test execution
  1275. rather than just summary information, pass the argument C<verbose=1>.
  1276.  
  1277. If you want to run tests under the perl debugger, pass the argument
  1278. C<debugger=1>.
  1279.  
  1280. In addition, if a file called C<visual.pl> exists in the top-level
  1281. directory, this file will be executed as a Perl script and its output
  1282. will be shown to the user.  This is a good place to put speed tests or
  1283. other tests that don't use the C<Test::Harness> format for output.
  1284.  
  1285. To override the choice of tests to run, you may pass a C<test_files>
  1286. argument whose value is a whitespace-separated list of test scripts to
  1287. run.  This is especially useful in development, when you only want to
  1288. run a single test to see whether you've squashed a certain bug yet:
  1289.  
  1290.  ./Build test --test_files t/something_failing.t
  1291.  
  1292. You may also pass several C<test_files> arguments separately:
  1293.  
  1294.  ./Build test --test_files t/one.t --test_files t/two.t
  1295.  
  1296. or use a C<glob()>-style pattern:
  1297.  
  1298.  ./Build test --test_files 't/01-*.t'
  1299.  
  1300. =item testcover
  1301.  
  1302. Runs the C<test> action using C<Devel::Cover>, generating a
  1303. code-coverage report showing which parts of the code were actually
  1304. exercised during the tests.
  1305.  
  1306. To pass options to C<Devel::Cover>, set the C<$DEVEL_COVER_OPTIONS>
  1307. environment variable:
  1308.  
  1309.   DEVEL_COVER_OPTIONS=-ignore,Build ./Build testcover
  1310.  
  1311. =item testdb
  1312.  
  1313. This is a synonym for the 'test' action with the C<debugger=1>
  1314. argument.
  1315.  
  1316. =item testpod
  1317.  
  1318. This checks all the files described in the C<docs> action and 
  1319. produces C<Test::Harness>-style output. If you are a module author,
  1320. this is useful to run before creating a new release.
  1321.  
  1322. =item clean
  1323.  
  1324. This action will clean up any files that the build process may have
  1325. created, including the C<blib/> directory (but not including the
  1326. C<_build/> directory and the C<Build> script itself).
  1327.  
  1328. =item realclean
  1329.  
  1330. This action is just like the C<clean> action, but also removes the
  1331. C<_build> directory and the C<Build> script.  If you run the
  1332. C<realclean> action, you are essentially starting over, so you will
  1333. have to re-create the C<Build> script again.
  1334.  
  1335. =item diff
  1336.  
  1337. This action will compare the files about to be installed with their
  1338. installed counterparts.  For .pm and .pod files, a diff will be shown
  1339. (this currently requires a 'diff' program to be in your PATH).  For
  1340. other files like compiled binary files, we simply report whether they
  1341. differ.
  1342.  
  1343. A C<flags> parameter may be passed to the action, which will be passed
  1344. to the 'diff' program.  Consult your 'diff' documentation for the
  1345. parameters it will accept - a good one is C<-u>:
  1346.  
  1347.  ./Build diff flags=-u
  1348.  
  1349. =item install
  1350.  
  1351. This action will use C<ExtUtils::Install> to install the files from
  1352. C<blib/> into the system.  See L<How Installation Paths are Determined> for details
  1353. about how Module::Build determines where to install things, and how to
  1354. influence this process.
  1355.  
  1356. If you want the installation process to look around in C<@INC> for
  1357. other versions of the stuff you're installing and try to delete it,
  1358. you can use the C<uninst> parameter, which tells C<ExtUtils::Install> to
  1359. do so:
  1360.  
  1361.  Build install uninst=1
  1362.  
  1363. This can be a good idea, as it helps prevent multiple versions of a
  1364. module from being present on your system, which can be a confusing
  1365. situation indeed.
  1366.  
  1367.  
  1368.  
  1369. =item fakeinstall
  1370.  
  1371. This is just like the C<install> action, but it won't actually do
  1372. anything, it will just report what it I<would> have done if you had
  1373. actually run the C<install> action.
  1374.  
  1375. =item versioninstall
  1376.  
  1377. ** Note: since C<only.pm> is so new, and since we just recently added
  1378. support for it here too, this feature is to be considered
  1379. experimental. **
  1380.  
  1381. If you have the C<only.pm> module installed on your system, you can
  1382. use this action to install a module into the version-specific library
  1383. trees. This means that you can have several versions of the same
  1384. module installed and C<use> a specific one like this:
  1385.  
  1386.  use only MyModule => 0.55;
  1387.  
  1388. To override the default installation libraries in C<only::config>,
  1389. specify the C<versionlib> parameter when you run the C<Build.PL> script:
  1390.  
  1391.  perl Build.PL versionlib=/my/version/place/
  1392.  
  1393. To override which version the module is installed as, specify the
  1394. C<versionlib> parameter when you run the C<Build.PL> script:
  1395.  
  1396.  perl Build.PL version=0.50
  1397.  
  1398. See the C<only.pm> documentation for more information on
  1399. version-specific installs.
  1400.  
  1401. =item manifest
  1402.  
  1403. This is an action intended for use by module authors, not people
  1404. installing modules.  It will bring the F<MANIFEST> up to date with the
  1405. files currently present in the distribution.  You may use a
  1406. F<MANIFEST.SKIP> file to exclude certain files or directories from
  1407. inclusion in the F<MANIFEST>.  F<MANIFEST.SKIP> should contain a bunch
  1408. of regular expressions, one per line.  If a file in the distribution
  1409. directory matches any of the regular expressions, it won't be included
  1410. in the F<MANIFEST>.
  1411.  
  1412. The following is a reasonable F<MANIFEST.SKIP> starting point, you can
  1413. add your own stuff to it:
  1414.  
  1415.    ^_build
  1416.    ^Build$
  1417.    ^blib
  1418.    ~$
  1419.    \.bak$
  1420.    ^MANIFEST\.SKIP$
  1421.    CVS
  1422.  
  1423. See the L<distcheck> and L<skipcheck> actions if you want to find out
  1424. what the C<manifest> action would do, without actually doing anything.
  1425.  
  1426. =item dist
  1427.  
  1428. This action is helpful for module authors who want to package up their
  1429. module for source distribution through a medium like CPAN.  It will create a
  1430. tarball of the files listed in F<MANIFEST> and compress the tarball using
  1431. GZIP compression.
  1432.  
  1433. By default, this action will use the external C<tar> and C<gzip>
  1434. executables on Unix-like platforms, and the C<Archive::Tar> module
  1435. elsewhere.  However, you can force it to use whatever executable you
  1436. want by supplying an explicit C<tar> (and optional C<gzip>) parameter:
  1437.  
  1438.  perl Build dist --tar C:\path\to\tar.exe --gzip C:\path\to\zip.exe
  1439.  
  1440. =item ppmdist
  1441.  
  1442. Generates a PPM binary distribution and a PPD description file.  This
  1443. action also invokes the 'ppd' action, so it can accept the same
  1444. C<codebase> argument described under that action.
  1445.  
  1446. This uses the same mechanism as the C<dist> action to tar & zip its
  1447. output, so you can supply C<tar> and/or C<gzip> parameters to affect
  1448. the result.
  1449.  
  1450. =item distsign
  1451.  
  1452. Uses C<Module::Signature> to create a SIGNATURE file for your
  1453. distribution, and adds the SIGNATURE file to the distribution's
  1454. MANIFEST.
  1455.  
  1456. =item distmeta
  1457.  
  1458. Creates the F<META.yml> file for your distribution.
  1459.  
  1460. =item distcheck
  1461.  
  1462. Reports which files are in the build directory but not in the
  1463. F<MANIFEST> file, and vice versa. (See L<manifest> for details)
  1464.  
  1465. =item skipcheck
  1466.  
  1467. Reports which files are skipped due to the entries in the
  1468. F<MANIFEST.SKIP> file (See L<manifest> for details)
  1469.  
  1470. =item distclean
  1471.  
  1472. Performs the 'realclean' action and then the 'distcheck' action.
  1473.  
  1474. =item distdir
  1475.  
  1476. Creates a directory called C<$(DISTNAME)-$(VERSION)> (if that
  1477. directory already exists, it will be removed first).  Then copies all
  1478. the files listed in the F<MANIFEST> file to that directory.  This
  1479. directory is what people will see when they download your distribution
  1480. and unpack it.
  1481.  
  1482. While performing the 'distdir' action, a file containing various bits
  1483. of "metadata" will be created.  The metadata includes the module's
  1484. name, version, dependencies, license, and the C<dynamic_config>
  1485. flag.  This file is created as F<META.yml> in YAML format, so you
  1486. must have the C<YAML> module installed in order to create it.  You
  1487. should also ensure that the F<META.yml> file is listed in your
  1488. F<MANIFEST> - if it's not, a warning will be issued.
  1489.  
  1490. =item disttest
  1491.  
  1492. Performs the 'distdir' action, then switches into that directory and
  1493. runs a C<perl Build.PL>, followed by the 'build' and 'test' actions in
  1494. that directory.
  1495.  
  1496. =item ppd
  1497.  
  1498. Build a PPD file for your distribution.
  1499.  
  1500. This action takes an optional argument C<codebase> which is used in
  1501. the generated ppd file to specify the (usually relative) URL of the
  1502. distribution. By default, this value is the distribution name without
  1503. any path information.
  1504.  
  1505. Example:
  1506.  
  1507.  perl Build ppd codebase="MSWin32-x86-multi-thread/Module-Build-0.21.tar.gz"
  1508.  
  1509. =back
  1510.  
  1511. =head2 How Installation Paths are Determined
  1512.  
  1513. When you invoke Module::Build's C<build> action, it needs to figure
  1514. out where to install things.  The nutshell version of how this works
  1515. is that default installation locations are determined from
  1516. F<Config.pm>, and they may be overridden by using the C<install_path>
  1517. parameter.  An C<install_base> parameter lets you specify an
  1518. alternative installation root like F</home/foo>, and a C<destdir> lets
  1519. you specify a temporary installation directory like F</tmp/install> in
  1520. case you want to create bundled-up installable packages.
  1521.  
  1522. Natively, Module::Build provides default installation locations for
  1523. the following types of installable items:
  1524.  
  1525. =over 4
  1526.  
  1527. =item lib
  1528.  
  1529. Usually pure-Perl module files ending in F<.pm>.
  1530.  
  1531. =item arch
  1532.  
  1533. "Architecture-dependent" module files, usually produced by compiling
  1534. XS, Inline, or similar code.
  1535.  
  1536. =item script
  1537.  
  1538. Programs written in pure Perl.  In order to improve reuse, try to make
  1539. these as small as possible - put the code into modules whenever
  1540. possible.
  1541.  
  1542. =item bin
  1543.  
  1544. "Architecture-dependent" executable programs, i.e. compiled C code or
  1545. something.  Pretty rare to see this in a perl distribution, but it
  1546. happens.
  1547.  
  1548. =item libdoc
  1549.  
  1550. Documentation for the stuff in C<lib> and C<arch>.  This is usually
  1551. generated from the POD in F<.pm> files.  Under Unix, these are manual
  1552. pages belonging to the 'man3' category.
  1553.  
  1554. =item bindoc
  1555.  
  1556. Documentation for the stuff in C<script> and C<bin>.  Usually
  1557. generated from the POD in those files.  Under Unix, these are manual
  1558. pages belonging to the 'man1' category.
  1559.  
  1560. =back
  1561.  
  1562. Four other parameters let you control various aspects of how
  1563. installation paths are determined:
  1564.  
  1565. =over 4
  1566.  
  1567. =item installdirs
  1568.  
  1569. The default destinations for these installable things come from
  1570. entries in your system's C<Config.pm>.  You can select from three
  1571. different sets of default locations by setting the C<installdirs>
  1572. parameter as follows:
  1573.  
  1574.                           'installdirs' set to:
  1575.                    core          site                vendor
  1576.  
  1577.               uses the following defaults from Config.pm:
  1578.  
  1579.  lib     => installprivlib  installsitelib      installvendorlib
  1580.  arch    => installarchlib  installsitearch     installvendorarch
  1581.  script  => installscript   installsitebin      installvendorbin
  1582.  bin     => installbin      installsitebin      installvendorbin
  1583.  libdoc  => installman3dir  installsiteman3dir  installvendorman3dir
  1584.  bindoc  => installman1dir  installsiteman1dir  installvendorman1dir
  1585.  
  1586. The default value of C<installdirs> is "site".  If you're creating
  1587. vendor distributions of module packages, you may want to do something
  1588. like this:
  1589.  
  1590.  perl Build.PL installdirs=vendor
  1591.  
  1592. or
  1593.  
  1594.  Build install installdirs=vendor
  1595.  
  1596. If you're installing an updated version of a module that was included
  1597. with perl itself (i.e. a "core module"), then you may set
  1598. C<installdirs> to "core" to overwrite the module in its present
  1599. location.
  1600.  
  1601. (Note that the 'script' line is different from MakeMaker -
  1602. unfortunately there's no such thing as "installsitescript" or
  1603. "installvendorscript" entry in C<Config.pm>, so we use the
  1604. "installsitebin" and "installvendorbin" entries to at least get the
  1605. general location right.  In the future, if C<Config.pm> adds some more
  1606. appropriate entries, we'll start using those.)
  1607.  
  1608. =item install_path
  1609.  
  1610. Once the defaults have been set, you can override them.  You can set
  1611. individual entries by using the C<install_path> parameter:
  1612.  
  1613.  my $m = Module::Build->new
  1614.   (...other options...,
  1615.    install_path => {lib  => '/foo/lib',
  1616.                     arch => '/foo/lib/arch'});
  1617.  
  1618. On the command line, that would look like this:
  1619.  
  1620.  perl Build.PL --install_path lib=/foo/lib --install_path arch=/foo/lib/arch
  1621.  
  1622. or this:
  1623.  
  1624.  Build install --install_path lib=/foo/lib --install_path arch=/foo/lib/arch
  1625.  
  1626. =item install_base
  1627.  
  1628. You can also set the whole bunch of installation paths by supplying the
  1629. C<install_base> parameter to point to a directory on your system.  For
  1630. instance, if you set C<install_base> to "/home/ken" on a Linux
  1631. system, you'll install as follows:
  1632.  
  1633.  lib     => /home/ken/lib
  1634.  arch    => /home/ken/lib/i386-linux
  1635.  script  => /home/ken/scripts
  1636.  bin     => /home/ken/bin
  1637.  bindoc  => /home/ken/man/man1
  1638.  libdoc  => /home/ken/man/man3
  1639.  
  1640. Note that this is I<different> from how MakeMaker's C<PREFIX>
  1641. parameter works.  C<PREFIX> tries to create a mini-replica of a
  1642. C<site>-style installation under the directory you specify, which is
  1643. not always possible (and the results are not always pretty in this
  1644. case).  C<install_base> just gives you a default layout under the
  1645. directory you specify, which may have little to do with the
  1646. C<installdirs=site> layout.
  1647.  
  1648. The exact layout under the directory you specify may vary by system -
  1649. we try to do the "sensible" thing on each platform.
  1650.  
  1651. =item destdir
  1652.  
  1653. If you want to install everything into a temporary directory first
  1654. (for instance, if you want to create a directory tree that a package
  1655. manager like C<rpm> or C<dpkg> could create a package from), you can
  1656. use the C<destdir> parameter:
  1657.  
  1658.  perl Build.PL destdir=/tmp/foo
  1659.  
  1660. or
  1661.  
  1662.  Build install destdir=/tmp/foo
  1663.  
  1664. This will effectively install to "/tmp/foo/$sitelib",
  1665. "/tmp/foo/$sitearch", and the like, except that it will use
  1666. C<File::Spec> to make the pathnames work correctly on whatever
  1667. platform you're installing on.
  1668.  
  1669. =back
  1670.  
  1671. =head1 SAVING CONFIGURATION INFORMATION
  1672.  
  1673. Module::Build provides a very convenient way to save configuration
  1674. information that your installed modules (or your regression tests) can
  1675. access.  If your Build process calls the C<feature()> or
  1676. C<config_data()> methods, then a C<Foo::Bar::ConfigData> module will
  1677. automatically be created for you, where C<Foo::Bar> is the
  1678. C<module_name> parameter as passed to C<new()>.  This module provides
  1679. access to the data saved by these methods, and a way to update the
  1680. values.  There is also a utility script called C<config_data>
  1681. distributed with Module::Build that provides a command-line interface
  1682. to this same functionality.  See also the generated
  1683. C<Foo::Bar::ConfigData> documentation, and the C<config_data>
  1684. script's documentation, for more information.
  1685.  
  1686.  
  1687.  
  1688. =head1 AUTOMATION
  1689.  
  1690. One advantage of Module::Build is that since it's implemented as Perl
  1691. methods, you can invoke these methods directly if you want to install
  1692. a module non-interactively.  For instance, the following Perl script
  1693. will invoke the entire build/install procedure:
  1694.  
  1695.  my $m = Module::Build->new(module_name => 'MyModule');
  1696.  $m->dispatch('build');
  1697.  $m->dispatch('test');
  1698.  $m->dispatch('install');
  1699.  
  1700. If any of these steps encounters an error, it will throw a fatal
  1701. exception.
  1702.  
  1703. You can also pass arguments as part of the build process:
  1704.  
  1705.  my $m = Module::Build->new(module_name => 'MyModule');
  1706.  $m->dispatch('build');
  1707.  $m->dispatch('test', verbose => 1);
  1708.  $m->dispatch('install', sitelib => '/my/secret/place/');
  1709.  
  1710. Building and installing modules in this way skips creating the
  1711. C<Build> script.
  1712.  
  1713. =head1 STRUCTURE
  1714.  
  1715. Module::Build creates a class hierarchy conducive to customization.
  1716. Here is the parent-child class hierarchy in classy ASCII art:
  1717.  
  1718.    /--------------------\
  1719.    |   Your::Parent     |  (If you subclass Module::Build)
  1720.    \--------------------/
  1721.             |
  1722.             |
  1723.    /--------------------\  (Doesn't define any functionality
  1724.    |   Module::Build    |   of its own - just figures out what
  1725.    \--------------------/   other modules to load.)
  1726.             |
  1727.             |
  1728.    /-----------------------------------\  (Some values of $^O may
  1729.    |   Module::Build::Platform::$^O    |   define specialized functionality.
  1730.    \-----------------------------------/   Otherwise it's ...::Default, a
  1731.             |                              pass-through class.)
  1732.             |
  1733.    /--------------------------\
  1734.    |   Module::Build::Base    |  (Most of the functionality of 
  1735.    \--------------------------/   Module::Build is defined here.)
  1736.  
  1737. =head1 SUBCLASSING
  1738.  
  1739. Right now, there are two ways to subclass Module::Build.  The first
  1740. way is to create a regular module (in a C<.pm> file) that inherits
  1741. from Module::Build, and use that module's class instead of using
  1742. Module::Build directly:
  1743.  
  1744.   ------ in Build.PL: ----------
  1745.   #!/usr/bin/perl
  1746.   
  1747.   use lib qw(/nonstandard/library/path);
  1748.   use My::Builder;  # Or whatever you want to call it
  1749.   
  1750.   my $m = My::Builder->new
  1751.     (module_name=> 'Next::Big::Thing',  # All the regular args...
  1752.      license=> 'perl',
  1753.      dist_author=> 'A N Other <me@here.net.au>',
  1754.      requires=> {Carp => 0});
  1755.   $m->create_build_script;
  1756.  
  1757. This is relatively straightforward, and is the best way to do things
  1758. if your My::Builder class contains lots of code.  The
  1759. C<create_build_script()> method will ensure that the current value of
  1760. C<@INC> (including the C</nonstandard/library/path>) is propogated to
  1761. the Build script, so that My::Builder can be found when running build
  1762. actions.
  1763.  
  1764. For very small additions, Module::Build provides a C<subclass()>
  1765. method that lets you subclass Module::Build more conveniently, without
  1766. creating a separate file for your module:
  1767.  
  1768.   ------ in Build.PL: ----------
  1769.   #!/usr/bin/perl
  1770.   
  1771.   use Module::Build;
  1772.   my $class = Module::Build->subclass
  1773.     (
  1774.      class => 'My::Builder',
  1775.      code => q{
  1776.       sub ACTION_foo {
  1777.         print "I'm fooing to death!\n";
  1778.       }
  1779.      },
  1780.     );
  1781.   
  1782.   my $m = $class->new
  1783.     (module_name=> 'Next::Big::Thing',  # All the regular args...
  1784.      license=> 'perl',
  1785.      dist_author=> 'A N Other <me@here.net.au>',
  1786.      requires=> {Carp => 0});
  1787.   $m->create_build_script;
  1788.  
  1789. Behind the scenes, this actually does create a C<.pm> file, since the
  1790. code you provide must persist after Build.PL is run if it is to be
  1791. very useful.
  1792.  
  1793. See also the documentation for the C<subclass()> method.
  1794.  
  1795.  
  1796. =head1 MOTIVATIONS
  1797.  
  1798. There are several reasons I wanted to start over, and not just fix
  1799. what I didn't like about MakeMaker:
  1800.  
  1801. =over 4
  1802.  
  1803. =item *
  1804.  
  1805. I don't like the core idea of MakeMaker, namely that C<make> should be
  1806. involved in the build process.  Here are my reasons:
  1807.  
  1808. =over 4
  1809.  
  1810. =item +
  1811.  
  1812. When a person is installing a Perl module, what can you assume about
  1813. their environment?  Can you assume they have C<make>?  No, but you can
  1814. assume they have some version of Perl.
  1815.  
  1816. =item +
  1817.  
  1818. When a person is writing a Perl module for intended distribution, can
  1819. you assume that they know how to build a Makefile, so they can
  1820. customize their build process?  No, but you can assume they know Perl,
  1821. and could customize that way.
  1822.  
  1823. =back
  1824.  
  1825. For years, these things have been a barrier to people getting the
  1826. build/install process to do what they want.
  1827.  
  1828. =item *
  1829.  
  1830. There are several architectural decisions in MakeMaker that make it
  1831. very difficult to customize its behavior.  For instance, when using
  1832. MakeMaker you do C<use ExtUtils::MakeMaker>, but the object created in
  1833. C<WriteMakefile()> is actually blessed into a package name that's
  1834. created on the fly, so you can't simply subclass
  1835. C<ExtUtils::MakeMaker>.  There is a workaround C<MY> package that lets
  1836. you override certain MakeMaker methods, but only certain explicitly
  1837. preselected (by MakeMaker) methods can be overridden.  Also, the method
  1838. of customization is very crude: you have to modify a string containing
  1839. the Makefile text for the particular target.  Since these strings
  1840. aren't documented, and I<can't> be documented (they take on different
  1841. values depending on the platform, version of perl, version of
  1842. MakeMaker, etc.), you have no guarantee that your modifications will
  1843. work on someone else's machine or after an upgrade of MakeMaker or
  1844. perl.
  1845.  
  1846. =item *
  1847.  
  1848. It is risky to make major changes to MakeMaker, since it does so many
  1849. things, is so important, and generally works.  C<Module::Build> is an
  1850. entirely separate package so that I can work on it all I want, without
  1851. worrying about backward compatibility.
  1852.  
  1853. =item *
  1854.  
  1855. Finally, Perl is said to be a language for system administration.
  1856. Could it really be the case that Perl isn't up to the task of building
  1857. and installing software?  Even if that software is a bunch of stupid
  1858. little C<.pm> files that just need to be copied from one place to
  1859. another?  My sense was that we could design a system to accomplish
  1860. this in a flexible, extensible, and friendly manner.  Or die trying.
  1861.  
  1862. =back
  1863.  
  1864.  
  1865. =head1 MIGRATION
  1866.  
  1867. Note that if you want to provide both a F<Makefile.PL> and a
  1868. F<Build.PL> for your distribution, you probably want to add the
  1869. following to C<WriteMakefile> in your F<Makefile.PL> so that MakeMaker
  1870. doesn't try to run your F<Build.PL> as a normal F<.PL> file:
  1871.  
  1872.  PL_FILES => {},
  1873.  
  1874. You may also be interested in looking at the C<Module::Build::Compat>
  1875. module, which can automatically create various kinds of F<Makefile.PL>
  1876. compatibility layers.
  1877.  
  1878. =head1 TO DO
  1879.  
  1880. The current method of relying on time stamps to determine whether a
  1881. derived file is out of date isn't likely to scale well, since it
  1882. requires tracing all dependencies backward, it runs into problems on
  1883. NFS, and it's just generally flimsy.  It would be better to use an MD5
  1884. signature or the like, if available.  See C<cons> for an example.
  1885.  
  1886. - append to perllocal.pod
  1887. - write .packlist in appropriate location (needed for un-install)
  1888. - add a 'plugin' functionality
  1889.  
  1890. =head1 AUTHOR
  1891.  
  1892. Ken Williams, kwilliams@cpan.org
  1893.  
  1894. Development questions, bug reports, and patches should be sent to the
  1895. Module-Build mailing list at module-build-general@lists.sourceforge.net .
  1896.  
  1897. Bug reports are also welcome at
  1898. http://rt.cpan.org/NoAuth/Bugs.html?Dist=Module-Build .
  1899.  
  1900. An anonymous CVS repository containing the latest development version
  1901. is available; see http://sourceforge.net/cvs/?group_id=45731 for the
  1902. details of how to access it.
  1903.  
  1904. =head1 SEE ALSO
  1905.  
  1906. perl(1), Module::Build::Cookbook(3), ExtUtils::MakeMaker(3), YAML(3)
  1907.  
  1908. http://www.dsmit.com/cons/
  1909.  
  1910. =cut
  1911.