[PULL 0/1] baum: better document usb-braille configuration

[PULL 0/1] baum: better document usb-braille configuration

[Samuel Thibault]

The following changes since commit 3e01455edd5fce06c14e2926b6ef408d9a94c9fb:

  usb-braille: Better explain that one also has to create a chardev backend (2022-09-06 00:09:50 +0200)

are available in the Git repository at:

  https://people.debian.org/~sthibault/qemu.git tags/samuel-thibault

for you to fetch changes up to 3e01455edd5fce06c14e2926b6ef408d9a94c9fb:

  usb-braille: Better explain that one also has to create a chardev backend (2022-09-06 00:09:50 +0200)

----------------------------------------------------------------
baum: better document usb-braille configuration

Samuel Thibault (1):
  usb-braille: Better explain that one also has to create a chardev
    backend

----------------------------------------------------------------

[PULL 1/1] usb-braille: Better explain that one also has to create a chardev backend

[Samuel Thibault]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=y, Size: 1380 bytes --]

Users have reported not to understand the documentation. This completes
it to give an explicit example how one is supposed to set up a virtual
braille USB device.

Signed-off-by: Samuel Thibault <samuel.thibault@ens-lyon.org>
---
 docs/system/devices/usb.rst | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

diff --git a/docs/system/devices/usb.rst b/docs/system/devices/usb.rst
index f39a88f080..37cb9b33ae 100644
--- a/docs/system/devices/usb.rst
+++ b/docs/system/devices/usb.rst
@@ -178,8 +178,20 @@ option or the ``device_add`` monitor command. Available devices are:
    host character device id.
 
 ``usb-braille,chardev=id``
-   Braille device. This will use BrlAPI to display the braille output on
-   a real or fake device referenced by id.
+   Braille device. This emulates a Baum Braille device USB port. id has to
+   specify a character device defined with ``-chardev …,id=id``.  One will
+   normally use BrlAPI to display the braille output on a BRLTTY-supported
+   device with
+
+   .. parsed-literal::
+
+      |qemu_system| [...] -chardev braille,id=brl -device usb-braille,chardev=brl
+
+   or alternatively, use the following equivalent shortcut:
+
+   .. parsed-literal::
+
+      |qemu_system| [...] -usbdevice braille
 
 ``usb-net[,netdev=id]``
    Network adapter that supports CDC ethernet and RNDIS protocols. id
-- 
2.35.1

Re: [PULL 0/1] baum: better document usb-braille configuration

[Stefan Hajnoczi]

[-- Attachment #1: Type: text/plain, Size: 115 bytes --]

Applied, thanks.

Please update the changelog at https://wiki.qemu.org/ChangeLog/7.2 for any user-visible changes.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]