diff mbox series

[v3,09/11] qapi: document DisplayType enum

Message ID 20190221110703.5775-10-marcandre.lureau@redhat.com
State New
Headers show
Series spice: add -display spice-app, setup and launch a Spice client | expand

Commit Message

Marc-André Lureau Feb. 21, 2019, 11:07 a.m. UTC
Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Tested-by: Victor Toso <victortoso@redhat.com>
---
 qapi/ui.json | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

Comments

Eric Blake Feb. 21, 2019, 1:59 p.m. UTC | #1
On 2/21/19 5:07 AM, Marc-André Lureau wrote:
> Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com>
> Tested-by: Victor Toso <victortoso@redhat.com>
> ---
>  qapi/ui.json | 25 +++++++++++++++++++++++++
>  1 file changed, 25 insertions(+)
> 
> diff --git a/qapi/ui.json b/qapi/ui.json
> index 7d9c4bddaf..7702ddf583 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -1085,6 +1085,31 @@
>  #
>  # Display (user interface) type.
>  #
> +# @default: The default user interface, selecting from the first available
> +#           of gtk, sdl, cocoa, and vnc.
> +#
> +# @none: No user interface or video output display. The guest will
> +#        still see an emulated graphics card, but its output will not
> +#        be displayed to the QEMU user.
> +#
> +# @gtk: The GTK user interface.
> +#
> +# @sdl: The SDL user interface.
> +#
> +# @egl-headless: No user interface, offload GL operations to a local
> +#                DRI device. Graphical display need to be paired with

s/need/needs/

> +#                VNC or Spice. (Since 3.1)
> +#

Are these retroactive documentation for things that existed in 3.1 or
2.12, or should any of them have '(since 4.0)' tags?  The commit message
should probably mention that.

> +# @curses: Display video output via curses.  For graphics device
> +#          models which support a text mode, QEMU can display this
> +#          output using a curses/ncurses interface. Nothing is
> +#          displayed when the graphics device is in graphical mode or
> +#          if the graphics device does not support a text
> +#          mode. Generally only the VGA device models support text
> +#          mode.
> +#
> +# @cocoa: The Cocoa user interface.
> +#
>  # Since: 2.12
>  #
>  ##
>
diff mbox series

Patch

diff --git a/qapi/ui.json b/qapi/ui.json
index 7d9c4bddaf..7702ddf583 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -1085,6 +1085,31 @@ 
 #
 # Display (user interface) type.
 #
+# @default: The default user interface, selecting from the first available
+#           of gtk, sdl, cocoa, and vnc.
+#
+# @none: No user interface or video output display. The guest will
+#        still see an emulated graphics card, but its output will not
+#        be displayed to the QEMU user.
+#
+# @gtk: The GTK user interface.
+#
+# @sdl: The SDL user interface.
+#
+# @egl-headless: No user interface, offload GL operations to a local
+#                DRI device. Graphical display need to be paired with
+#                VNC or Spice. (Since 3.1)
+#
+# @curses: Display video output via curses.  For graphics device
+#          models which support a text mode, QEMU can display this
+#          output using a curses/ncurses interface. Nothing is
+#          displayed when the graphics device is in graphical mode or
+#          if the graphics device does not support a text
+#          mode. Generally only the VGA device models support text
+#          mode.
+#
+# @cocoa: The Cocoa user interface.
+#
 # Since: 2.12
 #
 ##