qemu-ga: document vsock-listen in the man page
PATCH 1/1 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.
("qga: add vsock-listen method")
--- docs/interop/qemu-ga.rst | 5 +++-- qga/main.c | 4 +++- 2 files changed, 6 insertions(+), 3 deletions(-)
docs/interop/qemu-ga.rst +3 -2
@@ -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
qga/main.c +3 -1
@@ -234,7 +234,9 @@ QEMU_COPYRIGHT "\n"" -p, --path device/socket path (the default for virtio-serial is:\n" " %s,\n" " the default for isa-serial is:\n" -" %s)\n" +" %s).\n" +" Socket addresses for vsock-listen are written as\n" +" <cid>:<port>.\n" " -l, --logfile set logfile path, logs to stderr by default\n" " -f, --pidfile specify pidfile (default is %s)\n" #ifdef CONFIG_FSFREEZE
Signature · 1 line
2.24.1
Hi
Quoted 9 lines · Stefan Hajnoczi
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 <[email protected]>
Quoted 44 lines
--- docs/interop/qemu-ga.rst | 5 +++-- qga/main.c | 4 +++- 2 files changed, 6 insertions(+), 3 deletions(-)docs/interop/qemu-ga.rst +3
-2@@ -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=PATHqga/main.c +3
-2@@ -234,7 +234,9 @@ QEMU_COPYRIGHT "\n"" -p, --path device/socket path (the default for virtio-serial is:\n" " %s,\n" " the default for isa-serial is:\n" -" %s)\n" +" %s).\n" +" Socket addresses for vsock-listen are written as\n" +" <cid>:<port>.\n" " -l, --logfile set logfile path, logs to stderr by default\n" " -f, --pidfile specify pidfile (default is %s)\n" #ifdef CONFIG_FSFREEZE --2.24.1
Signature · 1 line
Marc-André Lureau
Quoted 52 lines · Stefan Hajnoczi
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 <[email protected]>--- docs/interop/qemu-ga.rst | 5 +++-- qga/main.c | 4 +++- 2 files changed, 6 insertions(+), 3 deletions(-)docs/interop/qemu-ga.rst +3
-2@@ -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=PATHqga/main.c +3
-1@@ -234,7 +234,9 @@ QEMU_COPYRIGHT "\n"" -p, --path device/socket path (the default for virtio-serial is:\n" " %s,\n" " the default for isa-serial is:\n" -" %s)\n" +" %s).\n" +" Socket addresses for vsock-listen are written as\n" +" <cid>:<port>.\n" " -l, --logfile set logfile path, logs to stderr by default\n" " -f, --pidfile specify pidfile (default is %s)\n" #ifdef CONFIG_FSFREEZESignature · 1 line
2.24.1
Thanks to update it!
I updated the wiki page some months ago, adding an example, but I forgot to check the most important man page and --help output.