Bug 890276

Summary:	A minor cosmetic defect occurs on man page of node-creator.
Product:	Red Hat Enterprise Linux 6	Reporter:	cshao <cshao>
Component:	ovirt-node	Assignee:	Ryan Barry <rbarry>
Status:	CLOSED ERRATA	QA Contact:	Virtualization Bugs <virt-bugs>
Severity:	low	Docs Contact:
Priority:	low
Version:	6.4	CC:	acathrow, bsarathy, cboyle, fdeutsch, gouyang, hadong, jboggs, leiwang, mburns, ovirt-maint, pschiffe, rbarry, ycui
Target Milestone:	rc	Keywords:	ManPageChange
Target Release:	---	Flags:	rbarry: needinfo-
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	ovirt-node-3.0.1-2.el6	Doc Type:	Bug Fix
Doc Text:	The man page of 'node-creator' contained a minor typographical error: man(8) node-creator man page man(8) NAME node-creator - prepare the kickstart recipe and build the LiveCD image SYNOPSIS node-creator [<RECIPE>] The <> symbols surrounding [<RECIPE>] are superfluous and have been removed. It now appears as [RECIPE].	Story Points:	---
Clone Of:		Environment:
Last Closed:	2014-01-21 19:17:52 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:

Description cshao 2012-12-26 06:57:51 UTC

Description of problem:
https://bugzilla.redhat.com/show_bug.cgi?id=811586#c9

The man page of node-creator can show properly, but there is a minor
cosmetic defect occurs on man page of node-creator.
============

man(8) node-creator man page man(8)

NAME
node-creator - prepare the kickstart recipe and build the LiveCD image

SYNOPSIS
node-creator [<RECIPE>]

============

The "<>" shouldn't appear in man page. So the "<>" can be removed for
"RECIPE".

Version-Release number of selected component (if applicable):
ovirt-node-tools-2.5.0-11.el6

How reproducible:
100%

Steps to Reproduce:
1. Install ovirt-node-tools-2.5.0-11.el6.
2. man node-creator
3.

Actual results:
There is a "<>" appear in man page of node-creator.

Expected results:
The "<>" can be removed for "RECIPE".

Additional info:

Comment 2 RHEL Program Management 2012-12-30 06:47:09 UTC

This request was not resolved in time for the current release.
Red Hat invites you to ask your support representative to
propose this request, if still desired, for consideration in
the next release of Red Hat Enterprise Linux.

Comment 4 Ryan Barry 2013-06-27 22:05:36 UTC

A fix for this has been posted:

http://gerrit.ovirt.org/#/c/16212/

Comment 7 cshao 2013-10-25 06:54:26 UTC

Test version:
rhev-hypervisor6-6.5-20131017.0
ovirt-node-3.0.1-4.el6.noarch
ovirt-node-tools-3.0.1-6.el6.noarch

I have to assigned this bug due to "No manual entry for node-creator" now.
I have noticed that the path have remove <> from <RECIPE> in node-creator manpage.
So change bug status to ASSIGNED.

# man node-creator 
No manual entry for node-creator

Comment 8 Ryan Barry 2013-10-25 13:59:39 UTC

This is intentional -- we don't ship manpages for any tools with the image. Please install ovirt-node-recipe (the package the manpage can be found in) on a RHEL system to test.

Comment 9 cshao 2013-10-28 08:03:13 UTC

(In reply to Ryan Barry from comment #8)
> This is intentional -- we don't ship manpages for any tools with the image.
> Please install ovirt-node-recipe (the package the manpage can be found in)
> on a RHEL system to test.


Test version:
ovirt-node-3.0.1-4.el6.noarch
ovirt-node-recipe-3.0.1-6.el6.noarch

The "<>" have been removed for "RECIPE", so the bug is fixed, change bug status to VERIFIED.

Comment 12 Cheryn Tan 2013-11-08 00:38:19 UTC

This bug is currently attached to errata RHBA-2013:15277. If this change is not to be documented in the text for this errata please either remove it from the errata, set the requires_doc_text flag to minus (-), or leave a "Doc Text" value of "--no tech note required" if you do not have permission to alter the flag.

Otherwise to aid in the development of relevant and accurate release documentation, please fill out the "Doc Text" field above with these four (4) pieces of information:

* Cause: What actions or circumstances cause this bug to present.
* Consequence: What happens when the bug presents.
* Fix: What was done to fix the bug.
* Result: What now happens when the actions or circumstances above occur. (NB: this is not the same as 'the bug doesn't present anymore')

Once filled out, please set the "Doc Type" field to the appropriate value for the type of change made and submit your edits to the bug.

For further details on the Cause, Consequence, Fix, Result format please refer to:

https://bugzilla.redhat.com/page.cgi?id=fields.html#cf_release_notes 

Thanks in advance.

Comment 14 errata-xmlrpc 2014-01-21 19:17:52 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.

http://rhn.redhat.com/errata/RHBA-2014-0033.html