diff mbox

help: Update help to reflect that GTK is the default

Message ID 1469636506-1768-1-git-send-email-clord@redhat.com (mailing list archive)
State New, archived
Headers show

Commit Message

clord@redhat.com July 27, 2016, 4:21 p.m. UTC
Updates the messages displayed in the help option to reflect that GTK is
the default display, not SDL.
---
 qemu-options.hx | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

Comments

Paolo Bonzini Aug. 1, 2016, 9:02 a.m. UTC | #1
On 27/07/2016 18:21, Colin Lord wrote:
> Updates the messages displayed in the help option to reflect that GTK is
> the default display, not SDL.
> ---
>  qemu-options.hx | 16 ++++++++++++----
>  1 file changed, 12 insertions(+), 4 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index 8e0d9a5..5bec1d3 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -967,7 +967,7 @@ DEF("nographic", 0, QEMU_OPTION_nographic,
>  STEXI
>  @item -nographic
>  @findex -nographic
> -Normally, QEMU uses SDL to display the VGA output. With this option,
> +Normally, QEMU uses GTK to display the VGA output. With this option,

IIRC SDL is the default if GTK is not enabled.  So perhaps "uses GTK or
SDL"?

Since you are at it, replace "the VGA output" with "output (such as
graphics, console, and the QEMU monitor)"

>  you can totally disable graphical output so that QEMU is a simple
>  command line application. The emulated serial port is redirected on
>  the console and muxed with the monitor (unless redirected elsewhere
> @@ -977,12 +977,12 @@ the console and monitor.
>  ETEXI
>  
>  DEF("curses", 0, QEMU_OPTION_curses,
> -    "-curses         use a curses/ncurses interface instead of SDL\n",
> +    "-curses         use a curses/ncurses interface instead of GTK\n",

Remove "instead of GTK" altogether?

>      QEMU_ARCH_ALL)
>  STEXI
>  @item -curses
>  @findex -curses
> -Normally, QEMU uses SDL to display the VGA output.  With this option,
> +Normally, QEMU uses GTK to display the VGA output.  With this option,

Same as above ("GTK or SDL").

>  QEMU can display the VGA output when in text mode using a
>  curses/ncurses interface.  Nothing is displayed in graphical mode.
>  ETEXI
> @@ -1034,6 +1034,14 @@ STEXI
>  Enable SDL.
>  ETEXI
>  
> +DEF("gtk", 0, QEMU_OPTION_gtk,
> +    "-gtk            enable GTK (default)\n", QEMU_ARCH_ALL)
> +STEXI
> +@item -gtk
> +@findex -gtk
> +Enable GTK.
> +ETEXI

We try to avoid adding new "-foo" options.  All of them invariably end
up requiring some sort of suboption, which is why we have "-display" now.

>  DEF("spice", HAS_ARG, QEMU_OPTION_spice,
>      "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
>      "       [,x509-key-file=<file>][,x509-key-password=<file>]\n"
> @@ -1228,7 +1236,7 @@ DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
>  STEXI
>  @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
>  @findex -vnc
> -Normally, QEMU uses SDL to display the VGA output.  With this option,
> +Normally, QEMU uses GTK to display the VGA output.  With this option,

Same as above ("GTK or SDL").

Thanks,

Paolo

>  you can have QEMU listen on VNC display @var{display} and redirect the VGA
>  display over the VNC session.  It is very useful to enable the usb
>  tablet device when using this option (option @option{-usbdevice
>
Markus Armbruster Aug. 1, 2016, 3:11 p.m. UTC | #2
Paolo Bonzini <pbonzini@redhat.com> writes:

> On 27/07/2016 18:21, Colin Lord wrote:
>> Updates the messages displayed in the help option to reflect that GTK is
>> the default display, not SDL.
>> ---
>>  qemu-options.hx | 16 ++++++++++++----
>>  1 file changed, 12 insertions(+), 4 deletions(-)
>> 
>> diff --git a/qemu-options.hx b/qemu-options.hx
>> index 8e0d9a5..5bec1d3 100644
>> --- a/qemu-options.hx
>> +++ b/qemu-options.hx
>> @@ -967,7 +967,7 @@ DEF("nographic", 0, QEMU_OPTION_nographic,
>>  STEXI
>>  @item -nographic
>>  @findex -nographic
>> -Normally, QEMU uses SDL to display the VGA output. With this option,
>> +Normally, QEMU uses GTK to display the VGA output. With this option,
>
> IIRC SDL is the default if GTK is not enabled.  So perhaps "uses GTK or
> SDL"?
>
> Since you are at it, replace "the VGA output" with "output (such as
> graphics, console, and the QEMU monitor)"
>
>>  you can totally disable graphical output so that QEMU is a simple
>>  command line application. The emulated serial port is redirected on
>>  the console and muxed with the monitor (unless redirected elsewhere
>> @@ -977,12 +977,12 @@ the console and monitor.
>>  ETEXI
>>  
>>  DEF("curses", 0, QEMU_OPTION_curses,
>> -    "-curses         use a curses/ncurses interface instead of SDL\n",
>> +    "-curses         use a curses/ncurses interface instead of GTK\n",
>
> Remove "instead of GTK" altogether?
>
>>      QEMU_ARCH_ALL)
>>  STEXI
>>  @item -curses
>>  @findex -curses
>> -Normally, QEMU uses SDL to display the VGA output.  With this option,
>> +Normally, QEMU uses GTK to display the VGA output.  With this option,
>
> Same as above ("GTK or SDL").
>
>>  QEMU can display the VGA output when in text mode using a
>>  curses/ncurses interface.  Nothing is displayed in graphical mode.
>>  ETEXI
>> @@ -1034,6 +1034,14 @@ STEXI
>>  Enable SDL.
>>  ETEXI
>>  
>> +DEF("gtk", 0, QEMU_OPTION_gtk,
>> +    "-gtk            enable GTK (default)\n", QEMU_ARCH_ALL)
>> +STEXI
>> +@item -gtk
>> +@findex -gtk
>> +Enable GTK.
>> +ETEXI
>
> We try to avoid adding new "-foo" options.  All of them invariably end
> up requiring some sort of suboption, which is why we have "-display" now.
>
>>  DEF("spice", HAS_ARG, QEMU_OPTION_spice,
>>      "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
>>      "       [,x509-key-file=<file>][,x509-key-password=<file>]\n"
>> @@ -1228,7 +1236,7 @@ DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
>>  STEXI
>>  @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
>>  @findex -vnc
>> -Normally, QEMU uses SDL to display the VGA output.  With this option,
>> +Normally, QEMU uses GTK to display the VGA output.  With this option,
>
> Same as above ("GTK or SDL").
>
> Thanks,
>
> Paolo
>
>>  you can have QEMU listen on VNC display @var{display} and redirect the VGA
>>  display over the VNC session.  It is very useful to enable the usb
>>  tablet device when using this option (option @option{-usbdevice

Please have a look at 

From: Robert Ho <robert.hu@intel.com>
Subject: [PATCH v2 1/1] Reorganize help output of '-display' option
Date: Tue, 26 Jul 2016 18:17:11 +0800
Message-Id: <1469528231-26206-1-git-send-email-robert.hu@intel.com>
diff mbox

Patch

diff --git a/qemu-options.hx b/qemu-options.hx
index 8e0d9a5..5bec1d3 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -967,7 +967,7 @@  DEF("nographic", 0, QEMU_OPTION_nographic,
 STEXI
 @item -nographic
 @findex -nographic
-Normally, QEMU uses SDL to display the VGA output. With this option,
+Normally, QEMU uses GTK to display the VGA output. With this option,
 you can totally disable graphical output so that QEMU is a simple
 command line application. The emulated serial port is redirected on
 the console and muxed with the monitor (unless redirected elsewhere
@@ -977,12 +977,12 @@  the console and monitor.
 ETEXI
 
 DEF("curses", 0, QEMU_OPTION_curses,
-    "-curses         use a curses/ncurses interface instead of SDL\n",
+    "-curses         use a curses/ncurses interface instead of GTK\n",
     QEMU_ARCH_ALL)
 STEXI
 @item -curses
 @findex -curses
-Normally, QEMU uses SDL to display the VGA output.  With this option,
+Normally, QEMU uses GTK to display the VGA output.  With this option,
 QEMU can display the VGA output when in text mode using a
 curses/ncurses interface.  Nothing is displayed in graphical mode.
 ETEXI
@@ -1034,6 +1034,14 @@  STEXI
 Enable SDL.
 ETEXI
 
+DEF("gtk", 0, QEMU_OPTION_gtk,
+    "-gtk            enable GTK (default)\n", QEMU_ARCH_ALL)
+STEXI
+@item -gtk
+@findex -gtk
+Enable GTK.
+ETEXI
+
 DEF("spice", HAS_ARG, QEMU_OPTION_spice,
     "-spice [port=port][,tls-port=secured-port][,x509-dir=<dir>]\n"
     "       [,x509-key-file=<file>][,x509-key-password=<file>]\n"
@@ -1228,7 +1236,7 @@  DEF("vnc", HAS_ARG, QEMU_OPTION_vnc ,
 STEXI
 @item -vnc @var{display}[,@var{option}[,@var{option}[,...]]]
 @findex -vnc
-Normally, QEMU uses SDL to display the VGA output.  With this option,
+Normally, QEMU uses GTK to display the VGA output.  With this option,
 you can have QEMU listen on VNC display @var{display} and redirect the VGA
 display over the VNC session.  It is very useful to enable the usb
 tablet device when using this option (option @option{-usbdevice