Bug 1419898 – Documentation inaccurate for __com.redhat_qxl_screendump and __com.redhat_drive_add

Bugzilla will be upgraded to version 5.0. The upgrade date is tentatively scheduled for 2 December 2018, pending final testing and feedback.

Bug 1419898 - Documentation inaccurate for __com.redhat_qxl_screendump and __com.redhat_drive_add

Summary:	Documentation inaccurate for __com.redhat_qxl_screendump and __com.redhat_dri...

Status:	CLOSED ERRATA

Aliases:	None

Product:	Red Hat Enterprise Linux 7
Classification:	Red Hat
Component:	qemu-kvm (Show other bugs)
Sub Component:
Version:	7.3
Hardware:	Unspecified Unspecified

Priority	unspecified Severity unspecified
Target Milestone:	rc
Target Release:	---
Assigned To:	Markus Armbruster
QA Contact:	Chao Yang
Docs Contact:

URL:
Whiteboard:
Keywords:

Depends On:	1419897
Blocks:	1419899
	Show dependency tree / graph

Reported:	2017-02-07 06:08 EST by Markus Armbruster
Modified:	2017-08-01 13:46 EDT (History)
CC List:	8 users (show)

See Also:
Fixed In Version:	qemu-kvm-1.5.3-131.el7
Doc Type:	If docs needed, set a value
Doc Text:
Story Points:	---
Clone Of:	1419897
Clones:	1419899 (view as bug list)
Environment:
Last Closed:	2017-08-01 13:46:48 EDT
Type:	Bug
Regression:	---
Mount Type:	---
Documentation:	---
CRM:
Verified Versions:
Category:	---
oVirt Team:	---
RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---

Attachments	(Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

External Trackers
Tracker	ID	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHSA-2017:1856	normal	SHIPPED_LIVE	Moderate: qemu-kvm security, bug fix, and enhancement update	2017-08-01 14:03:36 EDT

Groups: None (edit)

Description Markus Armbruster 2017-02-07 06:08:51 EST

+++ This bug was initially created as a clone of Bug #1419897 +++

Description of problem:
qemu-info.html section "3.5.1 Commands" documents __com.redhat_screendump instead of __com.redhat_qxl_screendump

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


How reproducible:
Always

Steps to Reproduce:
1. View usr/share/doc/qemu-kvm-0.12.1.2/qemu-doc.html
2. Search for _screendump
3.

Actual results:
Search finds
‘__com.redhat_screendump id filename’

    Save screen from qxl device id into PPM image filename. 

Expected results:
Should instead find
‘__com.redhat_qxl_screendump id filename’

    Save screen from qxl device id into PPM image filename. 

Additional info:
The typo is in qemu-monitor.hx.

Comment 1 Markus Armbruster 2017-02-07 06:09:59 EST

The typo has moved from qemu-monitor.hx to in hmp-commands.hx.

Comment 3 Markus Armbruster 2017-02-07 09:54:28 EST

Another doc bug:

‘__com.redhat_drive_add’

    Create a drive similar to -device if=none. 

This should be "similar to -drive if=none".

Comment 4 Miroslav Rezanina 2017-02-10 07:20:56 EST

Fix included in qemu-kvm-1.5.3-131.el7

Comment 6 Chao Yang 2017-05-03 05:38:18 EDT

$ git diff qemu-kvm-1.5.3-130.el7/usr/share/doc/qemu-kvm/qemu-doc.html qemu-kvm-1.5.3-137.el7/usr/share/doc/qemu-kvm/qemu-doc.html

...

-<dt><samp>__com.redhat_screendump <var>id</var> <var>filename</var></samp></dt>
-<dd><a name="index-_005f_005fcom_002eredhat_005fscreendump"></a>
+<dt><samp>__com.redhat_qxl_screendump <var>id</var> <var>filename</var></samp></dt>
+<dd><a name="index-_005f_005fcom_002eredhat_005fqxl_005fscreendump"></a>

...

 <dt><samp>__com.redhat_drive_add</samp></dt>
 <dd><a name="index-_005f_005fcom_002eredhat_005fdrive_005fadd"></a>
-<p>Create a drive similar to -device if=none.
+<p>Create a drive similar to -drive if=none.

...

Setting VERIFIED accordingly.

Comment 7 errata-xmlrpc 2017-08-01 13:46:48 EDT

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/RHSA-2017:1856

Note You need to log in before you can comment on or make changes to this bug.