Bug 1135146

Summary: Satellite 6: missing man page for hammer
Product: Red Hat Satellite Reporter: Xixi <xdmoon>
Component: HammerAssignee: Shlomi Zadok <szadok>
Status: CLOSED ERRATA QA Contact: jcallaha
Severity: high Docs Contact:
Priority: high    
Version: 6.0.3CC: adprice, bkearney, dcleal, dmoessne, ehelms, jcallaha, kshirsal, mbacovsk, mdavis, mmccune, nerawat, pmoravec, szadok, wpinheir, xdmoon
Target Milestone: UnspecifiedKeywords: PrioBumpGSS, PrioBumpPM, Triaged
Target Release: Unused   
Hardware: Unspecified   
OS: Unspecified   
URL: http://projects.theforeman.org/issues/7453
Whiteboard:
Fixed In Version: rubygem-hammer_cli-0.5.1.11-4 Doc Type: Bug Fix
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2016-07-27 11:01:09 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: 1115190    

Description Xixi 2014-08-29 00:13:41 UTC
Description of problem:
There's no manual for hammer - the commandline tool for Satellite 6.

Version-Release number of selected component (if applicable):
6.0.3

How reproducible:
always

Steps to Reproduce:
1. man hammer
2.
3.

Actual results:
no manpage

Expected results:
manpage

Additional info:
there's "hammer | more" and help options in the shell but it needs a proper manpage with usage, commands / options and explanations

Comment 1 RHEL Program Management 2014-08-29 00:32:55 UTC
Since this issue was entered in Red Hat Bugzilla, the release flag has been
set to ? to ensure that it is properly evaluated for this release.

Comment 3 Dustin Tsang 2014-09-09 22:12:42 UTC
accidentally moved to post; moving back to new

Comment 4 Bryan Kearney 2015-03-11 12:03:18 UTC
Upstream bug assigned to szadok

Comment 9 Bryan Kearney 2016-06-22 14:03:52 UTC
Moving to POST since upstream bug http://projects.theforeman.org/issues/7453 has been closed

Comment 11 Martin Bacovsky 2016-06-30 16:42:09 UTC
The compiled manpage is distributed with the gem but is not installed in proper path. I'll prepare packaging PR fixing that.

As a workaround:
$ cp /opt/theforeman/tfm/root/usr/share/gems/gems/hammer_cli-0.5.1.11/man/hammer.1.gz /usr/local/share/man/man1/

$ man hammer

Comment 12 Martin Bacovsky 2016-07-01 15:20:39 UTC
Upstream commit [1]  needs to be cherry-picked to hammer-cli packaging

[1] https://github.com/theforeman/foreman-packaging/commit/85a984c4fb4a9fa454d14a38de1e5b42c5e8ada5

Comment 13 Bryan Kearney 2016-07-06 17:58:00 UTC
VERIFIED
Version Verified on: 
* Snap 19
* satellite-installer-6.2.0.11-1.el7sat.noarch
tfm-rubygem-foreman_theme_satellite-0.1.22-1.el7sat.noarch
satellite-6.2.0-19.0.el7sat.noarch
satellite-cli-6.2.0-19.0.el7sat.noarch
[vagrant@sat-test-rhel7 ~]$ rpm -qa | grep hammer
tfm-rubygem-hammer_cli_katello-0.0.22.18-1.el7sat.noarch
tfm-rubygem-hammer_cli_import-0.10.23-1.el7sat.noarch
tfm-rubygem-hammer_cli-0.5.1.11-4.el7sat.noarch
tfm-rubygem-hammer_cli_foreman_docker-0.0.6-1.el7sat.noarch
tfm-rubygem-hammer_cli_foreman_remote_execution-0.0.5.3-1.el7sat.noarch
tfm-rubygem-hammer_cli_foreman-0.5.1.9-1.el7sat.noarch
tfm-rubygem-hammer_cli_foreman_bootdisk-0.1.3.3-1.el7sat.noarch
tfm-rubygem-hammer_cli_foreman_discovery-0.0.2.3-1.el7sat.noarch
tfm-rubygem-hammer_cli_foreman_tasks-0.0.10.3-1.el7sat.noarch
tfm-rubygem-hammer_cli_csv-2.0.0.1-1.el7sat.noarch


Steps to verify
* man hammer
* The text is sparse, but it tells the user to reference the help command which is acceptable for the first release.

Comment 14 Bryan Kearney 2016-07-27 11:01:09 UTC
Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHBA-2016:1501