[Bps-public-commit] r12999 - in Shipwright: trunk/lib/Shipwright/Script
spang at bestpractical.com
spang at bestpractical.com
Fri Jun 6 17:34:22 EDT 2008
Author: spang
Date: Fri Jun 6 17:34:22 2008
New Revision: 12999
Modified:
Shipwright/ (props changed)
Shipwright/trunk/lib/Shipwright/Script/Build.pm
Shipwright/trunk/lib/Shipwright/Script/Create.pm
Shipwright/trunk/lib/Shipwright/Script/Delete.pm
Shipwright/trunk/lib/Shipwright/Script/Flags.pm
Shipwright/trunk/lib/Shipwright/Script/Help.pm
Shipwright/trunk/lib/Shipwright/Script/Import.pm
Shipwright/trunk/lib/Shipwright/Script/List.pm
Shipwright/trunk/lib/Shipwright/Script/Maintain.pm
Shipwright/trunk/lib/Shipwright/Script/Rename.pm
Shipwright/trunk/lib/Shipwright/Script/Update.pm
Log:
r40976 at loki: spang | 2008-06-06 16:43:37 -0400
more polished command documentation
Modified: Shipwright/trunk/lib/Shipwright/Script/Build.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Build.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Build.pm Fri Jun 6 17:34:22 2008
@@ -81,22 +81,26 @@
=head1 NAME
-Shipwright::Script::Build - build the specified project
+Shipwright::Script::Build - Build the specified project
=head1 SYNOPSIS
- shipwright build build a project
+ build -r [repository]
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --install-base specify install base. default is an autocreated temp dir
- --skip specify dists which'll be skipped
- --only specify dists which'll be installed only
- --skip-test specify whether to skip test
- --only-test just test(the running script is t/test)
- --flags specify flags
- --name specify the name of the project
- --perl specify the path of perl that run the cmds in scripts/
+=head1 OPTIONS
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
+ --install-base PATH : specify install base, default is an autocreated
+ temp dir
+ --skip DISTS : specify dists which will be skipped
+ --only DISTS : specify dists to be installed (no others will
+ be installed)
+ --skip-test : specify whether to skip tests
+ --only-test : just test (run t/test)
+ --flags FLAGS : specify flags
+ --name NAME : specify the name of the project
+ --perl PATH : specify the path of perl that run the commands
+ in scripts/
Modified: Shipwright/trunk/lib/Shipwright/Script/Create.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Create.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Create.pm Fri Jun 6 17:34:22 2008
@@ -37,14 +37,15 @@
=head1 NAME
-Shipwright::Script::Create - create a project
+Shipwright::Script::Create - Create a project
=head1 SYNOPSIS
- shipwright create create a project
+ create -r [repository]
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
+=head1 OPTIONS
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
Modified: Shipwright/trunk/lib/Shipwright/Script/Delete.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Delete.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Delete.pm Fri Jun 6 17:34:22 2008
@@ -96,15 +96,15 @@
=head1 NAME
-Shipwright::Script::Delete - delete a dist
+Shipwright::Script::Delete - Delete a dist
=head1 SYNOPSIS
- shipwright delete delete a source
-
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --name specify the dist name
+ delete -r [repository] --name [dist name]
+=head1 OPTIONS
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
+ --name NAME : specify the dist name
Modified: Shipwright/trunk/lib/Shipwright/Script/Flags.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Flags.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Flags.pm Fri Jun 6 17:34:22 2008
@@ -80,15 +80,17 @@
=head1 NAME
-Shipwright::Script::Flags - maintain a dist's flags
+Shipwright::Script::Flags - Maintain a dist's flags
=head1 SYNOPSIS
- shipwright flags --name RT --add mysql
+ flags --name [dist name] --add [flag name]
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --name specify the dist name
- --add, --delete, --set specify the flags split by comma
+=head1 OPTIONS
+
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
+ --name NAME : specify the dist name
+ --add, --delete, --set FLAGS : specify the flags, split by commas
Modified: Shipwright/trunk/lib/Shipwright/Script/Help.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Help.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Help.pm Fri Jun 6 17:34:22 2008
@@ -10,9 +10,9 @@
=head1 NAME
-Shipwright::Script::Help - show help
+Shipwright::Script::Help - Show help
=head1 SYNOPSIS
- shipwright help COMMAND show help
+ help COMMAND
Modified: Shipwright/trunk/lib/Shipwright/Script/Import.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Import.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Import.pm Fri Jun 6 17:34:22 2008
@@ -374,33 +374,38 @@
=head1 NAME
-Shipwright::Script::Import - import a source(maybe with a lot of dependences)
+Shipwright::Script::Import - import a source and its dependencies
=head1 SYNOPSIS
- shipwright import import a source
+ import [source]
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --comment(-m) specify the comment
- --source(-s) specify the source path
- --name specify the source name( only alphanumeric characters, . and - )
- --build-script specify the build script
- --require-yml specify the require.yml
- --follow follow the dependent chain or not
- --extra-test specify the extra test source(for --only-test when build)
- --test-script specify the test script(for --only-test when build)
- --min-perl-version minimal perl version( default is the same as the one
- which runs this cmd )
- --overwrite import anyway even if we have deps dists in repo already
- --version specify the source's version
+=head1 OPTIONS
-=head2 supported source types
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ --log-file FILENAME : specify the log file
+ -m [--comment] COMMENT : specify the comment
+ -s [--source] PATH : specify the source path
+ --name NAME : specify the source name (only alphanumeric
+ characters, . and -)
+ --build-script FILENAME : specify the build script
+ --require-yml FILENAME : specify the require.yml
+ --follow : follow the dependent 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)
+ --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
-Generally, the format is L<type:schema>, be careful, there is no blank between
-type and schema, just a colon there.
+=head1 SUPPORTED SOURCE TYPES
+
+Generally, the format is L<type:schema>; be careful, there is no blank between
+type and schema, just a colon.
=over 4
@@ -423,7 +428,7 @@
e.g. L<http:http://example/foo-1.23.tar.gz>
-yeah, two `http:' are not good, we can omit one like this:
+You can also omit one `http', like this:
L<http://example.com/foo-1.23.tar.gz>
@@ -446,4 +451,3 @@
L<svn:http://svn.example.com/foo-1.23>
=back
-
Modified: Shipwright/trunk/lib/Shipwright/Script/List.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/List.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/List.pm Fri Jun 6 17:34:22 2008
@@ -159,17 +159,17 @@
=head1 NAME
-Shipwright::Script::List - list dists of a project
+Shipwright::Script::List - List dists of a project
=head1 SYNOPSIS
- shipwright list list dists of a project
-
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --name sepecify the dist name
- --with-latest-version show the latest version if possible
- --only-update only show the dists that can be updated
+ list
+=head1 OPTIONS
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ --log-file FILENAME : specify the log file
+ (info, debug, warn, error, or fatal)
+ --name NAME : sepecify the dist name
+ --with-latest-version : show the latest version if possible
+ --only-update : only show the dists that can be updated
Modified: Shipwright/trunk/lib/Shipwright/Script/Maintain.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Maintain.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Maintain.pm Fri Jun 6 17:34:22 2008
@@ -59,15 +59,17 @@
=head1 NAME
-Shipwright::Script::Maintain - maintain a project
+Shipwright::Script::Maintain - Maintain a project
=head1 SYNOPSIS
- shipwright maintain --update-order update the build order
+ maintain --update-order
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --update-order update the build order
+=head1 OPTIONS
+
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
+ --update-order : update the build order
Modified: Shipwright/trunk/lib/Shipwright/Script/Rename.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Rename.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Rename.pm Fri Jun 6 17:34:22 2008
@@ -105,16 +105,17 @@
=head1 NAME
-Shipwright::Script::Rename - rename a dist
+Shipwright::Script::Rename - Rename a dist
=head1 SYNOPSIS
shipwright rename rename a source
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --name specify the dist name
- --new-name specify the new dist name
+=head1 OPTIONS
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
+ --name NAME : specify the dist to be renamed
+ --new-name NAME : specify the new dist name
Modified: Shipwright/trunk/lib/Shipwright/Script/Update.pm
==============================================================================
--- Shipwright/trunk/lib/Shipwright/Script/Update.pm (original)
+++ Shipwright/trunk/lib/Shipwright/Script/Update.pm Fri Jun 6 17:34:22 2008
@@ -161,19 +161,24 @@
=head1 NAME
-Shipwright::Script::Update - update dist(s)
+Shipwright::Script::Update - Update dist(s) and scripts
=head1 SYNOPSIS
- shipwright update update dist(s)
-
- Options:
- --repository(-r) specify the repository of our project
- --log-level(-l) specify the log level
- --log-file specify the log file
- --name specify the source name( only alphanumeric characters and - )
- --all update all the dists
- --follow update one dist with all its deps(recursively)
- --builder update bin/shipwright-builder
- --utility update bin/shipwright-utility
+ update --all
+ update --name [dist] [--follow]
+ update --builder
+ update --utility
+
+=head1 OPTIONS
+
+ -r [--repository] REPOSITORY : specify the repository of our project
+ -l [--log-level] LOGLEVEL : specify the log level
+ (info, debug, warn, error, or fatal)
+ --log-file FILENAME : specify the log file
+ --name NAME : specify the name of the project
+ --all : update all dists
+ --follow : update one dist with all its dependencies
+ --builder : update bin/shipwright-builder
+ --utility : update bin/shipwright-utility
More information about the Bps-public-commit
mailing list