Bug 1154179

Summary: [RFE] insert dashes into all command line options composed of multiple words
Product: Red Hat Enterprise Linux 7 Reporter: John Sefler <jsefler>
Component: subscription-managerAssignee: Chris "Ceiu" Rog <crog>
Status: CLOSED WONTFIX QA Contact: John Sefler <jsefler>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 7.2CC: crog
Target Milestone: rcKeywords: FutureFeature
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: Enhancement
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2014-12-11 18:02:18 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:
Bug Depends On:    
Bug Blocks: 1005618    

Description John Sefler 2014-10-17 19:15:43 UTC
Description of problem:
One usability complaint against subscription-manager are all of the difficult to read command line options that are composed of multiple words (e.g. --servicelevel)  These can be improved by inserting a dash between the words (e.g. --service-level).

Beware: As many command line options are changed, a few other updates also need to be made...
  bash-completion
  man pages
  a deprecated warning when attempting to use the former option should be printed to stderr, but still pass through and execute the command
  

Version-Release number of selected component (if applicable):
[root@jsefler-7 ~]# subscription-manager version
server type: Red Hat Subscription Management
subscription management server: 0.9.26-1
subscription management rules: 5.11
subscription-manager: 1.13.3-1.el7
python-rhsm: 1.13.2.1-2.el7


How reproducible:


Steps to Reproduce:
After going through the CLI --help messages, I found all of these options that could be improved...


Actual results:
  --proxyuser=PROXY_USER
  --proxypassword=PROXY_PASSWORD
  --serverurl=SERVER_URL
  --serverurl=SERVERURL
  --ondate=ON_DATE
  --autoheal
  -s SERVICELEVEL, --servicelevel=SERVICELEVEL
  --servicelevel=SERVICE_LEVEL
  --listslots
  --listhooks
  --activationkey=ACTIVATION_KEYS
  --consumerid=SYSTEMID
  --name=SYSTEMNAME
  --type=UNITTYPE
  --baseurl=BASE_URL

Expected results:
  --proxy-user=PROXY_USER
  --proxy-password=PROXY_PASSWORD
  --server-url=SERVER_URL
  --server-url=SERVER_URL
  --on-date=ON_DATE
  --auto-heal
  -s SERVICE_LEVEL, --service-level=SERVICE_LEVEL
  --service-level=SERVICE_LEVEL
  --list-slots
  --list-hooks
  --activation-key=ACTIVATION_KEYS
  --consumer-id=SYSTEMID
  --name=SYSTEM-NAME
  --type=UNIT_TYPE
  --base-url=BASE_URL

Comment 1 John Sefler 2014-10-20 13:11:23 UTC
On second thought, the "baseurl" option is well understood and used in yum repo definitions.  I feel "baseurl" should remain as-is with no hyphen inserted.

Comment 2 Chris "Ceiu" Rog 2014-12-11 18:02:18 UTC
After some discussion, it seems likely that changing all of the commands at this point would cause more problems than it would solve. As such, existing commands will not be changed.

https://github.com/candlepin/subscription-manager/pull/1045