Bug 1373732 - [Docs][VMM] Installing usbdk on Windows needs updating
Summary: [Docs][VMM] Installing usbdk on Windows needs updating
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 4.0.0
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: ovirt-4.0.6
: ---
Assignee: Emma Heftman
QA Contact: Megan Lewis
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-09-07 05:09 UTC by Megan Lewis
Modified: 2019-05-07 13:13 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-01-12 14:51:58 UTC
oVirt Team: Docs
Target Upstream Version:

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

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
Note You need to log in before you can comment on or make changes to this bug.