Bug 783058

Summary: "domain destroy" option is not showing obliviously in the output of rhc-ctl-domain help message
Product: OKD Reporter: Johnny Liu <jialiu>
Component: ocAssignee: Abhishek Gupta <abhgupta>
Status: CLOSED CURRENTRELEASE QA Contact: libra bugs <libra-bugs>
Severity: medium Docs Contact:
Priority: medium    
Version: 1.xCC: bmeng
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: rhc-0.85.5-1 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2012-02-02 23:55:45 UTC Type: ---
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:

Description Johnny Liu 2012-01-19 08:33:32 UTC
Description of problem:
Run "rhc-ctl-domain -h", get the following output.
Usage: /usr/bin/rhc-ctl-domain
Manage multiple keys for the registered rhcloud user.

  rhc-ctl-domain -l <rhlogin> [-p <passwd>] (-a <key-name> [-k <ssh-pubkey>] | -r <key-name> | -u <key-name> [-k <ssh-pubkey>])

  -l|--rhlogin         rhlogin      Red Hat login (RHN or OpenShift login with OpenShift Express access) (Default: mytest)
  -p|--password        password     RHLogin password (optional, will prompt)
  -n|--namespace       namespace    Namespace for your application(s) (alphanumeric - max 16 chars) (required for destroying domain)
  -a|--add-ssh-key     key-name     Add SSH key to the user account (key-name is the user-specified identifier for the key)
  -r|--remove-ssh-key  key-name     Remove SSH key from the user account
  -u|--update-ssh-key  key-name     Update SSH key for the user account
  --destroy                         Destroys the domain and any added ssh keys
  -k|--ssh             key-filepath SSH public key filepath 
  --config             path         Path of alternate config file
  -d|--debug                        Print Debug info
  -h|--help                         Show Usage info


In the command line:
rhc-ctl-domain -l <rhlogin> [-p <passwd>] (-a <key-name> [-k <ssh-pubkey>] | -r <key-name> | -u <key-name> [-k <ssh-pubkey>])

It not give user a clear direction about this command can be used to destroy domain.

The output of "man rhc-ctl-domain" looks like more clear, I think they should keep insistent.
$ man rhc-ctl-domain
<--snip-->

SYNOPSIS
       rhc-ctl-domain  [-l rhlogin ] [-p password ] [-d] [-h] [-n namespace ] ( -a key-name [-k ssh-pubkey ] | -u key-name [-k ssh-pubkey ] | -r key-name
       ] | --destroy )

<--snip-->

Version-Release number of selected component (if applicable):
rhc-0.85.2-1.el6_2.noarch

How reproducible:
Always

Steps to Reproduce:
1. Run "man rhc-ctl-domain"
2. Run "rhc-ctl-domain -h"
3. Compare the output between them.
  
Actual results:
"rhc-ctl-domain -h" not give user a clear direction about this command can be used to destroy domain.

Expected results:
"rhc-ctl-domain -h" should be more clear.

Additional info:

Comment 1 Abhishek Gupta 2012-01-19 18:19:39 UTC
I have made the change to the command usage info and will check this in once I have the other changes related to US1317 stabilized.

Comment 2 Abhishek Gupta 2012-01-29 20:44:16 UTC
This fix has now been checked in.

Comment 3 Meng Bo 2012-01-30 07:43:30 UTC
verified on devenv_1567 with rhc-0.85.7-1.git.0.79b56b0.el6.noarch 
issue has been fixed.

Comment 4 Mrunal Patel 2012-02-02 23:55:45 UTC
Closing verified bugs.