[Bps-public-commit] r12853 - Shipwright/trunk/lib/Shipwright/Manual

[spang at bestpractical.com]

Author: spang
Date: Tue Jun  3 15:36:03 2008
New Revision: 12853

Modified:
   Shipwright/trunk/lib/Shipwright/Manual/CustomizeBuild.pod

Log:
Fleshed out the section of CustomizeBuild.pod on build scripts.

Modified: Shipwright/trunk/lib/Shipwright/Manual/CustomizeBuild.pod
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Manual/CustomizeBuild.pod	(original)
+++ Shipwright/trunk/lib/Shipwright/Manual/CustomizeBuild.pod	Tue Jun  3 15:36:03 2008
@@ -6,7 +6,9 @@
 =head1 DESCRIPTION
 
 There are currently two ways to build a dist: through a perl script
-(F<dists/foo/build.pl>), or using a list of tagged commands (F<dists/foo/build>).
+(F<dists/foo/build.pl>) which allows for heavy customization, or using a list
+of tagged commands (F<dists/foo/build>), which is simpler but less
+customizable.
 
 The script F<dists/foo/build.pl> has higher precedence, so if both
 F<dists/foo/build.pl> and F<dists/foo/build> exist, the former will be used.
@@ -43,8 +45,8 @@
 
 =item --clean
 
-If provided with this arg, the script should do the C<clean> work instead of
-C<install> work.
+If run with this argument, the script should do the C<clean> work instead of
+the C<install> work.
 
 =back
 
@@ -54,9 +56,13 @@
 C<type: command>. The command will be executed line by line, and the current
 working directory for building the dist I<foo> will be F<dists/foo>.
 
+In a normal build script, the following types of commands are specified:
+configure, make, install, clean, and sometimes test. Their functions should be
+self-explanatory for anyone familiar with building perl modules.
+
 Three template substitutions are available for use in the command:
 %%PERL%%, %%PERL_ARCHNAME%% and %%INSTALL_BASE%%. These can be used in cases
-%where the path to perl, the perl archname (e.g.
+where the path to perl, the perl archname (e.g.
 'i486-linux-gnu-thread-multi'), or the base install path are needed, since they
 are not known beforehand.