Bug #6093

hammer : description of options given under host-collection subscommands should be more clear and descriptive

Added by Tomáš Strachota over 3 years ago. Updated over 3 years ago.

Status:Closed
Priority:Normal
Assigned To:Tomáš Strachota
Category:Hammer
Target version:Sprint 33
Difficulty: Pull request:
Bugzilla link:1103073
Story points-
Velocity based estimate-
ReleaseKatello 2.0Release relationshipAuto

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1103073
Description of problem:
Description of options given under host-collection subscommands should be more clear and descriptive. For ex:

[root@dhcp207-55 ~]# hammer host-collection remove-content-host --help
Usage:
hammer host-collection remove-content-host [OPTIONS]

Options:
--id ID
--name NAME Name to search by
--organization ORGANIZATION_NAME
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL
--system SYSTEM_NAME
--system-id SYSTEM_ID
-h, --help print help

Please make it more user friendly. User should understand all options by their description.

here --id should have description like: ID of host-collection[required]
--name should have description Name of host-collection
--system Name of system

There are other areas as well which are not clear. like:

[root@dhcp207-55 ~]# hammer host-collection content-hosts --help
Usage:
hammer host-collection content-hosts [OPTIONS]

Options:
--activation-key ACTIVATION_KEY_NAME
--activation-key-id ACTIVATION_KEY_ID
--id ID Id of the host collection
--organization ORGANIZATION_NAME
--organization-id ORGANIZATION_ID
--organization-label ORGANIZATION_LABEL
--system SYSTEM_NAME
--system-id SYSTEM_ID
-h, --help print help

here what's the purpose of --system, assuming to list/search the list by specific list.?

Version-Release number of selected component (if applicable):
sat6 beta snap7 compose 2 (Satellite-6.0.3-RHEL-6-20140528.4)

How reproducible:
always

Steps to Reproduce:
1.
2.
3.

Actual results:

Expected results:
Description of options given under host-collection subscommands should be more clear and descriptive.

Additional info:

Associated revisions

Revision 7488b3a8
Added by Tomas Strachota over 3 years ago

Fixes #6093 - better option descriptions

- added custom descriptions for each searchable

History

#1 Updated by Tomáš Strachota over 3 years ago

  • Status changed from New to Assigned
  • Assigned To set to Tomáš Strachota
  • Triaged set to No

#2 Updated by Eric Helms over 3 years ago

  • Target version set to Sprint 32
  • Triaged changed from No to Yes

#4 Updated by Eric Helms over 3 years ago

  • Target version changed from Sprint 32 to Sprint 33

#5 Updated by Anonymous over 3 years ago

  • Status changed from Ready For Testing to Closed
  • % Done changed from 0 to 100

Applied in changeset hammer-cli-katello|commit:7488b3a8285eb2d252db35684400a2357f71308a.

#6 Updated by Eric Helms over 3 years ago

  • Release set to Katello 2.0

Also available in: Atom PDF