Bug 1373732

Summary:	[Docs][VMM] Installing usbdk on Windows needs updating
Product:	Red Hat Enterprise Virtualization Manager	Reporter:	Megan Lewis <melewis>
Component:	Documentation	Assignee:	Emma Heftman <eheftman>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Megan Lewis <melewis>
Severity:	unspecified	Docs Contact:
Priority:	unspecified
Version:	4.0.0	CC:	gklein, lbopf, lsurette, melewis, rbalakri, srevivo, uril, ykaul
Target Milestone:	ovirt-4.0.6
Target Release:	---
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2017-01-12 14:51:58 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	Docs	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description Megan Lewis 2016-09-07 05:09:17 UTC

While working with Uri Lublin on another bug he mentioned a couple of issues in the documentation on usbdk: 

"Looking at 1.4.2 Installing usbdk on Windows, I see it starts with:
"usbdk is a driver that is able to install and uninstall Windows USB drivers in guest virtual machines".

This is wrong, usbdk is a (filter) driver and it does not install/uninstall other drivers (which is what usbclerk did). usbdk enables remote-viewer exclusive access to USB devices on Windows OSes. (It can enable that capability to any user-space application)"

Comment 1 Uri Lublin 2016-09-07 09:33:37 UTC

1. Replace
 "is able to install and uninstall Windows USB drivers in guest virtual machines"
with
 "enables remote-viewer exclusive access to USB devices on Windows operating systems"

(reason: driver install/uninstall was done by USBClerk but not by usbdk).

2. The usbdk driver is installed on the client machine and not on the guest
  (which is now implied by mentioning "remote-viewer" in 1 above)
  Consider adding "on client machines" to title of
    "1.4. Installing Supporting Components"
  making it clear that those components (remote-viewer and usbdk) are
  to be installed on client machines.

3. Remove
 "The SPICE client sends requests to install or uninstall drivers for USB devices when users connect or disconnect USB devices to or from a guest, upon request."
This was true 

(reason: this was true with USBClerk but not with usbdk).

Thanks.

Comment 2 Lucy Bopf 2016-12-22 02:05:10 UTC

Assigning to Emma for review.

Emma, you'll need to make the line edits requested in Comment 1 to the Virtual Machine Management Guide.

Comment 3 Emma Heftman 2016-12-28 12:07:50 UTC

Please approve my changes.

Comment 7 Emma Heftman 2017-01-12 14:51:58 UTC

Link to updated documentation in the Customer Portal:

https://access.redhat.com/documentation/en/red-hat-virtualization/4.0/single/virtual-machine-management-guide/#sect-Installing_Supporting_Components