Changeset 914 for dasscm

Timestamp:

Jul 2, 2010, 5:16:50 PM (14 years ago)

Author:

joergs

Message:

added missing command descriptions

File:

• dasscm/trunk/usr/bin/dasscm (modified) (15 diffs)

dasscm/trunk/usr/bin/dasscm

@@ -76 +76 @@
 my %COMMAND_DEFINITIONS = (
     'help' => {
-        'desc'     => [],
+        'desc'     => ["print help and usage information"],
         'params'   => ["CMD"],
         'function' => \&help,
     },
     'login' => {
-        'desc'     => [],
+        'desc'     => ["user login to Subversion repositoty"],
         'params'   => ["USER"],
         'function' => \&login
@@ -94 +94 @@
     },
     'ls' => {
-        'desc'     => [],
+        'desc'     => ["list file from repository"],
         'params'   => ["PATH_REPO"],
         'function' => \&ls
     },
     'update' => {
-        'desc'     => [],
+        'desc' => [
+            "update local repository checkout",
+            "Normally, this is done automatically"
+        ],
         'params'   => ["PATH_REPO"],
         'function' => \&update
     },
     'add' => {
-        'desc'     => [],
+        'desc' => [
+            "add a file to the subversion repository",
+            "Unlike the native svn command,",
+            "dasscm adds and immediatly submits a file to the subversion repository"
+        ],
         'params'   => ["PATH_PROD"],
         'options'  => [ 'verbose', 'message=s' ],
@@ -111 +118 @@
     },
     'commit' => {
-        'desc'     => [],
+        'desc' => ["commit a changed file to the subversion repository"],
         ## TODO: only modified files
         'params'   => ["PATH_REPO"],
@@ -119 +126 @@
     },
     'revert' => {
-        'desc'     => ["revert local changes back to version from repository"],
+        'desc' => [
+            "revert local changes back to version from the repository (see diff)"
+        ],
         'params'   => ["PATH_REPO"],
         'function' => \&revert
     },
     'blame' => {
-        'desc' => [],
+        'desc' => ['like "svn blame"'],
         ## TODO: only files from PATH_REPO
         'params'   => ["PATH_REPO"],
@@ -130 +139 @@
     },
     'diff' => {
-        'desc'     => [],
+        'desc' => [
+            'display the differences between files on the system and the repository'
+        ],
         'params'   => ["PATH_REPO"],
         'function' => \&diff
     },
     'status' => {
-        'desc'     => [],
+        'desc' => [
+            'display status information about modified and deleted files.',
+            'If no path is given "/" is assumed',
+            '(in contract to "svn" with assumes ".")'
+        ],
         'params'   => ["PATH_REPO"],
         'function' => \&status
@@ -145 +160 @@
     },
     'permissions' => {
-        'desc'     => [],
+        'desc' =>
+          ["internal, used to update information about file permissions"],
         'params'   => [],
         'function' => \&permissions
     },
     'cleanup' => {
-        'desc'     => [],
+        'desc'     => ["internal, used to clean repository checkout"],
         'params'   => [],
         'function' => \&cleanup
     },
     'complete' => {
-        'desc'     => ["internally, used for bash completion"],
+        'desc'     => ["internal, used for bash completion"],
         'params'   => ["CMD"],
         'function' => \&complete
     },
     'complete_path' => {
-        'desc'     => ["internally, used for bash completion"],
+        'desc'     => ["internal, used for bash completion"],
         'params'   => [],
         'function' => \&complete_path
     },
     'complete_repopath' => {
-        'desc'     => ["internally, used for bash completion"],
+        'desc'     => ["internal, used for bash completion"],
         'params'   => [],
         'function' => \&complete_repopath
@@ -1576 +1592 @@
     # check and remove global options. if options are wrong, nothing to do
     @ARGV = @input;
-    if( GetOptions( \%options_complete, @OPTIONS_GLOBAL ) ) {
+    if ( GetOptions( \%options_complete, @OPTIONS_GLOBAL ) ) {
         my $number_arguments = @input;
         if ( $number_arguments <= 1 ) {
@@ -1584 +1600 @@
             map { m/^$input/ && print $_, "\n" } ( keys %COMMANDS );
         } else {
+
             # complete dasscm parameter
             my $command = get_command_uniform_name( $input[0] );
-            if( $command ) {
+            if ($command) {
+
                 # remove command
                 shift @input;
 
                 # check and remove options
-                my @options = get_command_possible_options( $command );
+                my @options = get_command_possible_options($command);
                 @ARGV = @input;
-                if( ( not @options ) || ( GetOptions( \%options_complete, @options ) ) ) {
-
-                    my @params  = get_command_possible_params( $command );
+                if (   ( not @options )
+                    || ( GetOptions( \%options_complete, @options ) ) )
+                {
+
+                    my @params = get_command_possible_params($command);
                     if ($verbose) { print "params: ", Dumper(@params); }
 
@@ -1602 +1622 @@
                     #print "input: ", join( ",", @input ), " (", $number_arguments, ")\n";
 
-                    if( $number_arguments > 0 ) {
+                    if ( $number_arguments > 0 ) {
                         my $parameter_number = $number_arguments - 1;
                         if ( defined( $params[$parameter_number] )
@@ -1608 +1628 @@
                         {
                             my $param = $params[$parameter_number];
-                            if ($verbose) { print "param used: ", $param, "\n"; }
+                            if ($verbose) {
+                                print "param used: ", $param, "\n";
+                            }
                             if ( $param eq "PATH_PROD" ) {
-                                complete_path( $input[ $number_arguments - 1 ] );
+                                complete_path(
+                                    $input[ $number_arguments - 1 ] );
                             } elsif ( $param eq "PATH_REPO" ) {
-                                complete_repopath( $input[ $number_arguments - 1 ] );
+                                complete_repopath(
+                                    $input[ $number_arguments - 1 ] );
                             }
                         }
@@ -1683 +1707 @@
 # global options
 # stops at first non-option
-Getopt::Long::Configure( 'require_order' );
-if( not GetOptions( \%options, @OPTIONS_GLOBAL ) ) {
+Getopt::Long::Configure('require_order');
+if ( not GetOptions( \%options, @OPTIONS_GLOBAL ) ) {
     usage();
     exit $RETURN_NOK;
@@ -1692 +1716 @@
 $verbose = $options{'verbose'};
 
-if( $options{'help'} ) {
+if ( $options{'help'} ) {
     help(@ARGV);
     exit;
@@ -1698 +1722 @@
 
 # get subcommand and remove it from @ARGV
-if( defined( $ARGV[0] ) ) {
+if ( defined( $ARGV[0] ) ) {
     $command = get_command_uniform_name( $ARGV[0] );
     shift @ARGV;
 }
 
-if( not defined($command) ) {
-        usage();
-        exit $RETURN_NOK;
+if ( not defined($command) ) {
+    usage();
+    exit $RETURN_NOK;
 }
 
@@ -1713 +1737 @@
 # TODO: check variables
 $DASSCM_SVN_REPOSITORY =
-    $config->{'DASSCM_SVN_REPOSITORY_BASE'} . "/" . $DASSCM_REPOSITORY_NAME;
+  $config->{'DASSCM_SVN_REPOSITORY_BASE'} . "/" . $DASSCM_REPOSITORY_NAME;
 
 $DASSCM_CHECKOUT_USERNAME = $config->{'DASSCM_CHECKOUT_USERNAME'};
@@ -1728 +1752 @@
 if ( $DASSCM_CHECKOUT_USERNAME && $DASSCM_CHECKOUT_PASSWORD ) {
     $svnCheckoutCredentials =
-        " --username $DASSCM_CHECKOUT_USERNAME --password $DASSCM_CHECKOUT_PASSWORD ";
+      " --username $DASSCM_CHECKOUT_USERNAME --password $DASSCM_CHECKOUT_PASSWORD ";
 }
 
 $DASSCM_PERMISSION_FILE = $config->{'DASSCM_PERMISSION_FILE'}
-    || "/etc/permissions.d/dasscm.permission_backup";
+  || "/etc/permissions.d/dasscm.permission_backup";
 
 # check for command options
-my @cmd_options = get_command_possible_options( $command );
-if( @cmd_options ) {
+my @cmd_options = get_command_possible_options($command);
+if (@cmd_options) {
+
     # get command line options and store them in options hash
     my $result = GetOptions( \%options, @cmd_options );