Bug 770458

Summary:	Request for backporting to move 'send-key' and 'echo' descriptions into other more appropriate sections in virsh man page
Product:	Red Hat Enterprise Linux 6	Reporter:	Satoru SATOH <ssato>
Component:	libvirt	Assignee:	Libvirt Maintainers <libvirt-maint>
Status:	CLOSED ERRATA	QA Contact:	Virtualization Bugs <virt-bugs>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	6.2	CC:	acathrow, dallan, dyuan, eblake, mzhan, rwu, tzheng, yupzhang
Target Milestone:	rc
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	libvirt-0.9.9-1.el6	Doc Type:	Bug Fix
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2012-06-20 06:40:18 UTC	Type:	---
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:
Embargoed:

Description Satoru SATOH 2011-12-26 18:51:51 UTC

Description of problem:
Both 'send-key' and 'echo' command descriptions are in wrong place 
and should be moved to more appropriate sections in virsh man page.

The changes are trivial and I made patches fixing this issue
and there were merged into upstream already.

* http://libvirt.org/git/?p=libvirt.git;a=commit;h=1f24ddf6bfde0f0c24865f29e59ea017f6f8d6b6

* http://libvirt.org/git/?p=libvirt.git;a=commit;h=b2c545bf8050d566b17da4f8263f7a76bdf21a2a


These fixes looks also applicable to libvirt in RHEL 6.2. So
could you please consider backporting these fixes?


Version-Release number of selected component (if applicable):
libvirt-0.9.4-23.el6

How reproducible: man virsh

Comment 2 Eric Blake 2011-12-28 13:49:19 UTC

The fixes will be included in 6.3 by virtue of rebasing.  But I'm not sure whether documentation-only patches are worth backporting via z-stream process to 6.2.z.

Comment 3 Dave Allan 2012-01-04 03:23:06 UTC

Documentation fixes are not appropriate for z-stream.

Comment 5 tingting zheng 2012-01-10 03:33:07 UTC

Verified the bug with libvirt-0.9.9-1.el6.x86_64
Check:
'echo' command description has been move into the generic commands section
'send-key' command description has been moved into the domain commands section
# man virsh
GENERIC COMMANDS
       The following commands are generic i.e. not specific to a domain.
       ……
       echo [--shell] [--xml] [arg...]
           Echo back each arg, separated by space.  If --shell is specified, then the output will be single-quoted where needed, so that it is suitable for reuse in a shell context.  If --xml is specified,then the output will be escaped for use in XML.

DOMAIN COMMANDS
       The following commands manipulate domains directly, as stated previously most commands take domain-id as the first parameter. The domain-id can be specified as a short integer, a name or a full UUID.
       ……
       send-key domain-id [--codeset codeset] [--holdtime holdtime] keycode...
           Parse the keycode sequence as keystrokes to send to domain-id.  Each keycode can either be a numeric value or a symbolic name from the corresponding codeset.  If --holdtime is given, each keystroke will be held for that many milliseconds.  The default codeset is linux, but use of the --codeset option allows other codesets to be chosen.

Comment 7 errata-xmlrpc 2012-06-20 06:40:18 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/RHSA-2012-0748.html