Thread: [Module-build-checkins] Module-Build/lib/Module Build.pm,1.213,1.214
Status: Beta
Brought to you by:
kwilliams
From: Randy W. S. <si...@us...> - 2006-03-16 09:38:07
|
Update of /cvsroot/module-build/Module-Build/lib/Module In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv24870/lib/Module Modified Files: Build.pm Log Message: Changes Index: Build.pm =================================================================== RCS file: /cvsroot/module-build/Module-Build/lib/Module/Build.pm,v retrieving revision 1.213 retrieving revision 1.214 diff -u -d -r1.213 -r1.214 --- Build.pm 12 Mar 2006 03:55:32 -0000 1.213 +++ Build.pm 16 Mar 2006 09:37:58 -0000 1.214 @@ -217,25 +217,25 @@ =item build +[version 0.01] + If you run the C<Build> script without any arguments, it runs the C<build> action, which in turn runs the C<code> and C<docs> actions. This is analogous to the MakeMaker 'make all' target. -=item testpodcoverage - -This checks the pod coverage of the distribution and -produces C<Test::Harness>-style output. If you are a module author, -this is useful to run before creating a new release. - =item clean +[version 0.01] + This action will clean up any files that the build process may have created, including the C<blib/> directory (but not including the C<_build/> directory and the C<Build> script itself). =item code +[version 0.20] + This action builds your codebase. By default it just creates a C<blib/> directory and copies any C<.pm> @@ -254,10 +254,14 @@ =item config_data +[version 0.26] + ... =item diff +[version 0.14] + This action will compare the files about to be installed with their installed counterparts. For .pm and .pod files, a diff will be shown (this currently requires a 'diff' program to be in your PATH). For @@ -272,6 +276,8 @@ =item dist +[version 0.02] + This action is helpful for module authors who want to package up their module for source distribution through a medium like CPAN. It will create a tarball of the files listed in F<MANIFEST> and compress the tarball using @@ -286,15 +292,21 @@ =item distcheck +[version 0.05] + Reports which files are in the build directory but not in the F<MANIFEST> file, and vice versa. (See L<manifest> for details.) =item distclean +[version 0.05] + Performs the 'realclean' action and then the 'distcheck' action. =item distdir +[version 0.05] + Creates a "distribution directory" named C<$dist_name-$dist_version> (if that directory already exists, it will be removed first), then copies all the files listed in the F<MANIFEST> file to that directory. @@ -302,6 +314,8 @@ =item distmeta +[version 0.21] + Creates the F<META.yml> file that describes the distribution. F<META.yml> is a file containing various bits of "metadata" about the @@ -317,18 +331,24 @@ =item distsign +[version 0.16] + Uses C<Module::Signature> to create a SIGNATURE file for your distribution, and adds the SIGNATURE file to the distribution's MANIFEST. =item disttest +[version 0.05] + Performs the 'distdir' action, then switches into that directory and runs a C<perl Build.PL>, followed by the 'build' and 'test' actions in that directory. =item docs +[version 0.20] + This will generate documentation (e.g. Unix man pages and html documents) for any installable items under B<blib/> that contain POD. If there are no C<bindoc> or C<libdoc> installation @@ -339,12 +359,16 @@ =item fakeinstall +[version 0.02] + This is just like the C<install> action, but it won't actually do anything, it will just report what it I<would> have done if you had actually run the C<install> action. =item help +[version 0.03] + This action will simply print out a message that is meant to help you use the build process. It will show you a list of available build actions too. @@ -355,6 +379,8 @@ =item html +[version 0.26] + This will generate HTML documentation for any binary or library files under B<blib/> that contain POD. The HTML documentation will only be installed if the install paths can be determined from values in @@ -364,6 +390,8 @@ =item install +[version 0.01] + This action will use C<ExtUtils::Install> to install the files from C<blib/> into the system. See L<INSTALL PATHS> for details about how Module::Build determines where to install @@ -382,6 +410,8 @@ =item manifest +[version 0.05] + This is an action intended for use by module authors, not people installing modules. It will bring the F<MANIFEST> up to date with the files currently present in the distribution. You may use a @@ -407,6 +437,8 @@ =item manpages +[version 0.28] + This will generate man pages for any binary or library files under B<blib/> that contain POD. The man pages will only be installed if the install paths can be determined from values in C<Config.pm>. You can @@ -416,6 +448,8 @@ =item ppd +[version 0.20] + Build a PPD file for your distribution. This action takes an optional argument C<codebase> which is used in @@ -429,6 +463,8 @@ =item ppmdist +[version 0.23] + Generates a PPM binary distribution and a PPD description file. This action also invokes the 'ppd' action, so it can accept the same C<codebase> argument described under that action. @@ -439,6 +475,8 @@ =item prereq_report +[version 0.28] + This action prints out a list of all prerequisites, the versions required, and the versions actually installed. This can be useful for reviewing the configuration of your system prior to a build, or when compiling data to send @@ -446,6 +484,8 @@ =item pure_install +[version 0.28] + This action is identical to the C<install> action. In the future, though, if C<install> starts writing to the file file F<$(INSTALLARCHLIB)/perllocal.pod>, C<pure_install> won't, and that @@ -453,6 +493,8 @@ =item realclean +[version 0.01] + This action is just like the C<clean> action, but also removes the C<_build> directory and the C<Build> script. If you run the C<realclean> action, you are essentially starting over, so you will @@ -460,11 +502,15 @@ =item skipcheck +[version 0.05] + Reports which files are skipped due to the entries in the F<MANIFEST.SKIP> file (See L<manifest> for details) =item test +[version 0.01] + This will use C<Test::Harness> to run any regression tests and report their results. Tests can be defined in the standard places: a file called C<test.pl> in the top-level directory, or several files ending @@ -498,6 +544,8 @@ =item testcover +[version 0.26] + Runs the C<test> action using C<Devel::Cover>, generating a code-coverage report showing which parts of the code were actually exercised during the tests. @@ -509,17 +557,31 @@ =item testdb +[version 0.05] + This is a synonym for the 'test' action with the C<debugger=1> argument. =item testpod +[version 0.25] + This checks all the files described in the C<docs> action and produces C<Test::Harness>-style output. If you are a module author, this is useful to run before creating a new release. +=item testpodcoverage + +[version 0.28] + +This checks the pod coverage of the distribution and +produces C<Test::Harness>-style output. If you are a module author, +this is useful to run before creating a new release. + =item versioninstall +[version 0.16] + ** Note: since C<only.pm> is so new, and since we just recently added support for it here too, this feature is to be considered experimental. ** @@ -583,6 +645,8 @@ =head2 Default Options File (F<.modulebuildrc>) +[version 0.28] + When Module::Build starts up, it will look for a file, F<$ENV{HOME}/.modulebuildrc>. If the file exists, the options specified there will be used as defaults, as if they were typed on the @@ -615,6 +679,8 @@ =head1 INSTALL PATHS +[version 0.19] + When you invoke Module::Build's C<build> action, it needs to figure out where to install things. The nutshell version of how this works is that default installation locations are determined from @@ -782,6 +848,8 @@ =head2 About PREFIX Support +[version 0.28] + First, it is necessary to understand the original idea behind C<PREFIX>. If, for example, the default installation locations for your machine are F</usr/local/lib/perl5/5.8.5> for modules, |