[Bps-public-commit] r13534 - in Shipwright: trunk/lib/Shipwright/Script

[spang at bestpractical.com]

Author: spang
Date: Mon Jun 23 09:34:10 2008
New Revision: 13534

Modified:
   Shipwright/   (props changed)
   Shipwright/trunk/lib/Shipwright/Script/Import.pm
   Shipwright/trunk/lib/Shipwright/Script/Update.pm

Log:
 r41726 at loki:  spang | 2008-06-23 14:27:22 +0100
 add DESCRIPTION section to Update.pm's pod


Modified: Shipwright/trunk/lib/Shipwright/Script/Import.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Import.pm	(original)
+++ Shipwright/trunk/lib/Shipwright/Script/Import.pm	Mon Jun 23 09:34:10 2008
@@ -410,17 +410,27 @@
                                   characters, . and -)
  --build-script FILENAME        : specify the build script
  --require-yml FILENAME         : specify the require.yml
- --follow                       : follow the dependent chain or not
+ --follow                       : follow the dependency chain or not
  --extra-test FILENAME          : specify the extra test source
                                   (for --only-test when building)
  --test-script FILENAME         : specify the test script (for --only-test when
-                                  build)
+                                  building)
  --min-perl-version             : minimal perl version (default is the same as
                                   the one which runs this command)
  --overwrite                    : import dependency dists anyway even if they
                                   are already in the repository
  --version                      : specify the source's version
 
+=head1 DESCRIPTION
+
+The import command imports a new dist into a shipwright repository from any of
+a number of supported source types (enumerated below). If a dist of the name
+specified by C<--name> already exists in the repository, the old files for that
+dist in F<dists/> and F<scripts/> are deleted and new ones added. This is the
+recommended method for updating non-svn, svk, or CPAN dists to new versions
+(see L<Shipwright::Update for more information on the C<update> command, which
+is used for updating svn, svk, and CPAN dists).
+
 =head1 SUPPORTED SOURCE TYPES
 
 Generally, the format is L<type:schema>; be careful, there is no blank between

Modified: Shipwright/trunk/lib/Shipwright/Script/Update.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Update.pm	(original)
+++ Shipwright/trunk/lib/Shipwright/Script/Update.pm	Mon Jun 23 09:34:10 2008
@@ -183,7 +183,7 @@
 =head1 DESCRIPTION
 
 The update command updates one or multiple svk, svn, or CPAN dists in a
-shipwright repository to the latest version. Only the source in F<dists/>
+Shipwright repository to the latest version. Only the source in F<dists/>
 will be updated. To update other types of sources, you must re-import the new
 version, using the same name in order to overwrite. The C<import> command will
 also re-generate files in F<scripts/> (see L<Shipwright::Import> for more