summary refs log tree commit diff stats
path: root/docs/interop
diff options
context:
space:
mode:
authorStefan Hajnoczi <stefanha@redhat.com>2020-03-23 11:04:08 +0000
committerMichael Roth <mdroth@linux.vnet.ibm.com>2020-03-24 11:32:19 -0500
commit7b46aadbbfb7b06cd45a3b113b1f7c003c68f603 (patch)
treea5639b11d38e264df738c9539feed949e40fdc4f /docs/interop
parenta23f38a72921fa915536a981a4f8a9134512f120 (diff)
downloadfocaccia-qemu-7b46aadbbfb7b06cd45a3b113b1f7c003c68f603.tar.gz
focaccia-qemu-7b46aadbbfb7b06cd45a3b113b1f7c003c68f603.zip
qemu-ga: document vsock-listen in the man page
Although qemu-ga has supported vsock since 2016 it was not documented on
the man page.

Also add the socket address representation to the qga --help output.

Fixes: 586ef5dee77180fc32e33bc08051600030630239
       ("qga: add vsock-listen method")
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Reviewed-by: Stefano Garzarella <sgarzare@redhat.com>
Signed-off-by: Michael Roth <mdroth@linux.vnet.ibm.com>
Diffstat (limited to 'docs/interop')
-rw-r--r--docs/interop/qemu-ga.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/interop/qemu-ga.rst b/docs/interop/qemu-ga.rst
index 1313a4ae1c..3063357bb5 100644
--- a/docs/interop/qemu-ga.rst
+++ b/docs/interop/qemu-ga.rst
@@ -36,13 +36,14 @@ Options
 .. option:: -m, --method=METHOD
 
   Transport method: one of ``unix-listen``, ``virtio-serial``, or
-  ``isa-serial`` (``virtio-serial`` is the default).
+  ``isa-serial``, or ``vsock-listen`` (``virtio-serial`` is the default).
 
 .. option:: -p, --path=PATH
 
   Device/socket path (the default for virtio-serial is
   ``/dev/virtio-ports/org.qemu.guest_agent.0``,
-  the default for isa-serial is ``/dev/ttyS0``)
+  the default for isa-serial is ``/dev/ttyS0``). Socket addresses for
+  vsock-listen are written as ``<cid>:<port>``.
 
 .. option:: -l, --logfile=PATH