Bug1311730: Fixing short-form optparse options

thrasher-redhat · thrasher-redhat · commit 3b5dcf0807f3 · 2016-05-20T15:57:05.000-04:00
Bug 1311730 BZ: https://bugzilla.redhat.com/show_bug.cgi?id=1311730 Errors were being seen when command line tools using the 'optparse' libary. Using long-form only options with a single dash was resulting in odd returns, but no errors. This is because optparse automatically infers a short-form option for long-form options that have a unique starting letter. So '--ids' has an implied short-form of '-i'. This meant that running a command with '-ids' would actually use '-i' and pass in "ds" as an ID value. This commit takes several cases where this happens and explicitely defines the short-form options in the relevant scripts and man pages, which should reduce confusion on why certain options may not error out as expected. Also updates an old man page to reflect the current options.
diff --git a/broker-util/man/oo-admin-broker-auth.8 b/broker-util/man/oo-admin-broker-auth.8
@@ -7,7 +7,7 @@
 .nf
 .fam C
 \fBoo-admin-broker-auth\fP [\fB-h\fP|\fB--help\fP] [\fB-t\fP|\fB--timeout\fP \fIinteger\fP] 
-[\fB--find-gears\fP] [\fB--verbose\fP] [\fB--dryrun\fP] [\fB--rekey-all\fP] [\fB--rekey\fP \fIuuid\fP]
+[\fB--find-gears\fP] [\fB--verbose\fP] [\fB--dryrun\fP] [\fB--rekey-all\fP] [\fB-r\fP|\fB--rekey\fP \fIuuid\fP]
 
 .fam T
 .fi
@@ -34,7 +34,7 @@ Print out gears with using Broker key authentication.
 \fB--dryrun\fP
 Show what would be done. Useful for finding discrepancies in Nodes reported by the Broker datastore and the message bus.
 .PP
-\fB--verbose\fP
+\fB-v\fP|\fB--verbose\fP
 Show debugging information 
 .SH EXAMPLE
 
diff --git a/broker-util/man/oo-admin-ctl-app.8 b/broker-util/man/oo-admin-ctl-app.8
@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH oo-admin-ctl-app 8 "15 September 2014" "" ""
+.TH oo-admin-ctl-app 8 "20 May 2016" "" ""
 .SH NAME
 \fBoo-admin-ctl-app
 \fB
@@ -29,6 +29,9 @@ Login with OpenShift access. Required.
 .B
 \fB-a\fP|\fB--app\fP \fIapp_name\fP
 Application name, alphanumeric. Required.
+.PP
+\fB-n\fP|\fB--domain\fP domain
+Domain name.
 .TP
 .B
 \fB-c\fP|\fB--command\fP \fIcmd\fP
@@ -51,6 +54,9 @@ Alias to operate on.
 .B
 \fB-b\fP|\fB--bypass\fP
 Ignore all warnings.
+.PP
+\fB--multiplier\fP multiplier
+Multiplier factor to be set for the cartridge.
 .SH EXAMPLE
 
 $ \fBoo-admin-ctl-app\fP \fB-l\fP mylogin \fB-a\fP myappname \fB-c\fP status
diff --git a/broker-util/man/oo-admin-ctl-app.txt2man b/broker-util/man/oo-admin-ctl-app.txt2man
@@ -18,6 +18,9 @@ OPTIONS
 
   -a|--app app_name  
     Application name, alphanumeric. Required.
+
+  -n|--domain domain
+    Domain name.
   
   -c|--command cmd  
     Command to envoke upon the application, available commands are: start,
@@ -36,6 +39,9 @@ OPTIONS
   -b|--bypass  
     Ignore all warnings.
 
+  --multiplier multiplier
+    Multiplier factor to be set for the cartridge.
+
 EXAMPLE
 
   $ oo-admin-ctl-app -l mylogin -a myappname -c status
diff --git a/broker-util/man/oo-admin-ctl-cartridge.8 b/broker-util/man/oo-admin-ctl-cartridge.8
@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH oo-admin-ctl-cartridge 8 "17 September 2014" "" ""
+.TH oo-admin-ctl-cartridge 8 "20 May 2016" "" ""
 .SH NAME
 \fBoo-admin-ctl-cartridge
 \fB
@@ -59,11 +59,11 @@ This is an administrative utility to manage cartridges.
 \fB-h\fP|\fB--help\fP
 Display a simple usage page.
 .PP
-\fB--dry-run\fP
+\fB-d\fP|\fB--dry-run\fP
 Display the results of running an operation, but do not make any changes
 to the database.
 .PP
-\fB--raw\fP
+\fB-r\fP|\fB--raw\fP
 When outputting cartridge information, display each manifest as JSON
 .PP
 \fB-a\fP|\fB--active\fP
@@ -78,26 +78,26 @@ A comma-delimited list of cartridge names. Used by the "delete" command.
 \fB--all\fP
 Display all information
 .PP
-\fB--ids\fP IDS
+\fB-i\fP|\fB--ids\fP IDS
 ID for a cartridge version to activate or deactivate (comma-delimited).
 .PP
 \fB--node\fP NODE
 With import-node, server-identity for a node to import from.
 .PP
-\fB--profile\fP PROFILES
+\fB-p\fP|\fB--profile\fP PROFILES
 With import-profile, profile to import from (may be comma-separated list).
 .PP
 \fB-u\fP|\fB--url\fP URL
 URL of a cartrige manifest to import.
 .PP
-\fB--broker\fP PATH
+\fB-b\fP|\fB--broker\fP PATH
 The path to the broker (default /var/www/openshift/broker/config/environment)
 .PP
-\fB--force\fP
+\fB-f\fP|\fB--force\fP
 By default, import and import-node will skip unchanged cartridges. Use this
 switch to force them to create a new version.
 .PP
-\fB--obsolete\fP
+\fB-o\fP|\fB--obsolete\fP
 By default, obsolete cartridges will not be activated. Use this switch to
 automatically update obsolete cartridges.
 .PP
diff --git a/broker-util/man/oo-admin-ctl-cartridge.txt2man b/broker-util/man/oo-admin-ctl-cartridge.txt2man
@@ -48,11 +48,11 @@ OPTIONS
   -h|--help
     Display a simple usage page.
 
-  --dry-run
+  -d|--dry-run
     Display the results of running an operation, but do not make any changes
     to the database.
 
-  --raw
+  -r|--raw
     When outputting cartridge information, display each manifest as JSON
 
   -a|--active
@@ -67,26 +67,26 @@ OPTIONS
   --all
     Display all information
 
-  --ids IDS
+  -i|--ids IDS
     ID for a cartridge version to activate or deactivate (comma-delimited).
 
   --node NODE
     With import-node, server-identity for a node to import from.
 
-  --profile PROFILES
+  -p|--profile PROFILES
     With import-profile, profile to import from (may be comma-separated list).
 
   -u|--url URL
     URL of a cartrige manifest to import.
 
-  --broker PATH
+  -b|--broker PATH
     The path to the broker (default /var/www/openshift/broker/config/environment)
 
-  --force
+  -f|--force
     By default, import and import-node will skip unchanged cartridges. Use this
     switch to force them to create a new version.
 
-  --obsolete
+  -o|--obsolete
     By default, obsolete cartridges will not be activated. Use this switch to
     automatically update obsolete cartridges.
 
diff --git a/broker-util/man/oo-app-info.8 b/broker-util/man/oo-app-info.8
@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH untitled  "07 November 2013" "" ""
+.TH untitled  "20 May 2016" "" ""
 .SH NAME
 \fBoo-app-info
 \fB
@@ -47,7 +47,7 @@ Comma-delimited list of Application or Gear uuids or regular expressions
 Additional:
 \fB--deleted\fP
 Look for deleted Applications
-\fB--raw\fP
+\fB-r\fP or \fB--raw\fP
 Print raw data structure without formatting.
 .RE
 .PP
diff --git a/broker-util/man/oo-app-info.txt2man b/broker-util/man/oo-app-info.txt2man
@@ -33,7 +33,7 @@ OPTIONS
   Additional:
     --deleted
       Look for deleted Applications
-    --raw
+    -r or --raw
       Print raw data structure without formatting.
   
 
diff --git a/broker-util/oo-admin-broker-auth b/broker-util/oo-admin-broker-auth
@@ -34,7 +34,8 @@ oo-admin-broker-auth OPTIONS
 Options:
 --rekey-all
     Rekey all Gears using Broker authentication tokens
---rekey [uuid]
+-r|--rekey [uuid]
+    Rekey an individual gear
 -t|--timeout [integer]
     How long to wait for MCollective Node discovery
 -v|--verbose
diff --git a/broker-util/oo-admin-ctl-cartridge b/broker-util/oo-admin-ctl-cartridge
@@ -540,20 +540,20 @@ or names.
     options.command = command
   end
 
-  opts.on('--broker PATH', "The path to the broker",
+  opts.on('-b', '--broker PATH', "The path to the broker",
           " (default #{PATH})") do |path|
     options.broker = path
   end
 
-  opts.on('--raw', "Dump all cartridge information as JSON") do
+  opts.on('-r', '--raw', "Dump all cartridge information as JSON") do
     options.raw = true
   end
 
-  opts.on('--force', "Replace with new version even if unchanged") do
+  opts.on('-f', '--force', "Replace with new version even if unchanged") do
     options.force = true
   end
 
-  opts.on('--obsolete', "Force activation of obsolete cartridges") do
+  opts.on('-o', '--obsolete', "Force activation of obsolete cartridges") do
     options.obsolete = true
   end
 
@@ -565,7 +565,7 @@ or names.
     options.activate = true
   end
 
-  opts.on('--dry-run', "Show the results of the update without changing anything.") do
+  opts.on('-d', '--dry-run', "Show the results of the update without changing anything.") do
     options.dry_run = true
   end
 
@@ -581,7 +581,7 @@ or names.
     options.quiet = true
   end
 
-  opts.on('--ids IDS', "ID for a cartridge version to activate or deactivate (comma-delimited).") do |ids|
+  opts.on('-i', '--ids IDS', "ID for a cartridge version to activate or deactivate (comma-delimited).") do |ids|
     options.ids = ids.split(/[\, ]/)
   end
 
diff --git a/broker-util/oo-app-info b/broker-util/oo-app-info
@@ -85,7 +85,7 @@ if $0 == __FILE__
     opts.separator ''
     opts.separator 'Additional:'
     opts.on('--deleted', 'Look for deleted Applications') { params[:deleted] = true }
-    opts.on('--raw', 'Print raw data structure without formatting.') { params[:raw] = true }
+    opts.on('r', '--raw', 'Print raw data structure without formatting.') { params[:raw] = true }
   end
   optparse.parse!
 
diff --git a/node-util/man8/oo-admin-cartridge.8 b/node-util/man8/oo-admin-cartridge.8
@@ -1,5 +1,5 @@
 .\" Text automatically generated by txt2man
-.TH oo-admin-cartridge 8 "17 July 2014" "" ""
+.TH oo-admin-cartridge 8 "20 May 2016" "" ""
 .SH NAME
 \fBoo-admin-cartridge
 \fB
@@ -28,7 +28,7 @@ Display a simple help menu.
 \fB-d\fP|\fB--debug\fP
 Provide additional output.
 .SH COMMANDS
-\fB--action\fP ACTION
+\fB-a\fP|\fB--action\fP ACTION
 \fIinstall\fP copies the cartridge source found at the \fIdirectory\fP provided by \fB--source\fP into the cartridge repository
 .RS
 .TP
@@ -42,18 +42,22 @@ to determine the version of the cartridge is not being used in any gear.
 \fIlist\fP the cartridge versions installed in the cartridge repository
 .RE
 .PP
-\fB--recursive\fP
+\fB-R\fP|\fB--recursive\fP
 The source \fIdirectory\fP provided contains cartridge source directories, rather than pointing to one cartridge
 .PP
-\fB--mco\fP
-Use the mcollective mco agent to update the cartridge repository.  (only supported in testing environments)
+\fB-m\fP|\fB--mco\fP
+.RS
+.TP
+.B
+Use the mcollective mco agent to update the cartridge repository.
+(only supported in testing environments)
+.RE
 .PP
-\fB--cartridge_vendor\fP \fIVENDOR\fP \fB--name\fP \fINAME\fP \fB--version\fP \fIVERSION\fP \fB--cartridge_version\fP \fIVERSION\fP
-.br
+\fB-o\fP|\fB--cartridge_vendor\fP \fIVENDOR\fP \fB--name\fP \fINAME\fP \fB--version\fP \fIVERSION\fP \fB--cartridge_version\fP \fIVERSION\fP
 When erasing a cartridge from the cartridge repository you must provide the exact version to remove. 'redhat' is the
 default \fIVENDOR\fP.
 .PP
-\fB--force\fP
+\fB-f\fP|\fB--force\fP
 Override verifications before erasing cartridge from repository
 .SH CONFIGURATION
 /usr/libexec/openshift/cartridges
diff --git a/node-util/man8/oo-admin-cartridge.txt2man b/node-util/man8/oo-admin-cartridge.txt2man
@@ -22,23 +22,23 @@ OPTIONS
     Provide additional output.
 
 COMMANDS
-  --action ACTION
+  -a|--action ACTION
     install copies the cartridge source found at the directory provided by --source into the cartridge repository
     erase   removes the named version of the cartridge from the cartridge repository. It is up to the OpenShift Operator
             to determine the version of the cartridge is not being used in any gear.
     list    list the cartridge versions installed in the cartridge repository
 
-  --recursive
+  -R|--recursive
     The source directory provided contains cartridge source directories, rather than pointing to one cartridge
 
-  --mco
+  -m|--mco
     Use the mcollective mco agent to update the cartridge repository.  (only supported in testing environments)
 
-  --cartridge_vendor VENDOR --name NAME --version VERSION --cartridge_version VERSION
+  -o|--cartridge_vendor VENDOR --name NAME --version VERSION --cartridge_version VERSION
     When erasing a cartridge from the cartridge repository you must provide the exact version to remove. 'redhat' is the
     default VENDOR.
 
-  --force
+  -f|--force
     Override verifications before erasing cartridge from repository
 
 CONFIGURATION
diff --git a/node-util/sbin/oo-admin-regenerate-gear-metadata b/node-util/sbin/oo-admin-regenerate-gear-metadata
@@ -158,7 +158,7 @@ if __FILE__ == $0
 
     opts.on('-y', '--assumeyes', 'Answer yes for all questions') { opt_assume_yes = true }
     opts.on('-q', '--quiet', 'Quiet operation') { opt_verbose = false }
-    opts.on('--no-accept-node', 'Don\'t run accept node') { opt_run_accept_node = false }
+    opts.on('-n', '--no-accept-node', 'Don\'t run accept node') { opt_run_accept_node = false }
   end
   optparse.parse!
 
