[Bps-public-commit] r13629 - in Shipwright: . trunk/lib/Shipwright/Source

[spang at bestpractical.com]

Author: spang
Date: Thu Jun 26 19:13:48 2008
New Revision: 13629

Modified:
   Shipwright/   (props changed)
   Shipwright/trunk/lib/Shipwright/Manual/UsingFlags.pod
   Shipwright/trunk/lib/Shipwright/Source/CPAN.pm

Log:
 r43145 at loki:  spang | 2008-06-26 23:56:50 +0100
 document mandatory flags in the manual


Modified: Shipwright/trunk/lib/Shipwright/Manual/UsingFlags.pod
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Manual/UsingFlags.pod	(original)
+++ Shipwright/trunk/lib/Shipwright/Manual/UsingFlags.pod	Thu Jun 26 19:13:48 2008
@@ -25,6 +25,7 @@
     $ shipwright flags -r ... --name cpan-DBD-mysql --set mysql
     $ shipwright flags -r ... --name postgresql --set postgresql
     $ shipwright flags -r ... --name cpan-DBD-Pg --set postgresql
+    $ shipwright flags -r ... --mandatory --set mysql,postgresql --name db
 
 B<Flags> data is stored in F<shipwright/flags.yml>
 
@@ -39,6 +40,13 @@
 installed to the vessel. Which one RT chooses to configure for depends on its
 build script.
 
+If necessary, you can also specify certain flags as being mandatory. For
+example, you can specify that a database flag is mandatory; if no flag labelled
+C<db> is specified when invoking the build script, the first one is used as a
+default (mysql in this case) rather than the repository being built with no
+flags. This allows repositories to support different variants or versions of a
+program.
+
 Note:
 
 Shipwright will automatically add C<default> to C<--flags>, and if a

Modified: Shipwright/trunk/lib/Shipwright/Source/CPAN.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Source/CPAN.pm	(original)
+++ Shipwright/trunk/lib/Shipwright/Source/CPAN.pm	Thu Jun 26 19:13:48 2008
@@ -18,6 +18,12 @@
 my $cpan_dir = tempdir( CLEANUP => 0 );
 unshift @INC, $cpan_dir;
 
+=head1 NAME
+
+Shipwright::Source::CPAN - CPAN source
+
+=head1 DESCRIPTION
+
 =head2 new
 
 =cut
@@ -145,39 +151,3 @@
 }
 
 1;
-
-__END__
-
-=head1 NAME
-
-Shipwright::Source::CPAN - CPAN source
-
-
-=head1 DESCRIPTION
-
-
-=head1 DEPENDENCIES
-
-None.
-
-
-=head1 INCOMPATIBILITIES
-
-None reported.
-
-
-=head1 BUGS AND LIMITATIONS
-
-No bugs have been reported.
-
-=head1 AUTHOR
-
-sunnavy  C<< <sunnavy at bestpractical.com> >>
-
-
-=head1 LICENCE AND COPYRIGHT
-
-Copyright 2007 Best Practical Solutions.
-
-This program is free software; you can redistribute it and/or modify it
-under the same terms as Perl itself.