[v3] ui: Print available display backends with '-display help'
diff mbox series

Message ID 20200108144702.29969-1-thuth@redhat.com
State New
Headers show
Series
  • [v3] ui: Print available display backends with '-display help'
Related show

Commit Message

Thomas Huth Jan. 8, 2020, 2:47 p.m. UTC
We already print availabled devices with "-device help", or available
backends with "-netdev help" or "-chardev help". Let's provide a way
for the users to query the available display backends, too.

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
---
 v3: Mention -display help in the qemu-doc, too (as suggested by Philippe)

 include/ui/console.h |  1 +
 qemu-options.hx      |  3 ++-
 ui/console.c         | 15 +++++++++++++++
 vl.c                 |  5 +++++
 4 files changed, 23 insertions(+), 1 deletion(-)

Comments

Philippe Mathieu-Daudé Jan. 8, 2020, 2:50 p.m. UTC | #1
On 1/8/20 3:47 PM, Thomas Huth wrote:
> We already print availabled devices with "-device help", or available
> backends with "-netdev help" or "-chardev help". Let's provide a way
> for the users to query the available display backends, too.
> 
> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>   v3: Mention -display help in the qemu-doc, too (as suggested by Philippe)
> 
>   include/ui/console.h |  1 +
>   qemu-options.hx      |  3 ++-
>   ui/console.c         | 15 +++++++++++++++
>   vl.c                 |  5 +++++
>   4 files changed, 23 insertions(+), 1 deletion(-)
> 
> diff --git a/include/ui/console.h b/include/ui/console.h
> index 281f9c145b..f35b4fc082 100644
> --- a/include/ui/console.h
> +++ b/include/ui/console.h
> @@ -442,6 +442,7 @@ void qemu_display_register(QemuDisplay *ui);
>   bool qemu_display_find_default(DisplayOptions *opts);
>   void qemu_display_early_init(DisplayOptions *opts);
>   void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
> +void qemu_display_help(void);
>   
>   /* vnc.c */
>   void vnc_display_init(const char *id, Error **errp);
> diff --git a/qemu-options.hx b/qemu-options.hx
> index e9d6231438..d593931664 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1586,7 +1586,8 @@ STEXI
>   @item -display @var{type}
>   @findex -display
>   Select type of display to use. This option is a replacement for the
> -old style -sdl/-curses/... options. Valid values for @var{type} are
> +old style -sdl/-curses/... options. Use @code{-display help} to list
> +the available display types. Valid values for @var{type} are

Nicer, thanks!

>   @table @option
>   @item sdl
>   Display video output via SDL (usually in a separate graphics
> diff --git a/ui/console.c b/ui/console.c
> index ac79d679f5..69339b028b 100644
> --- a/ui/console.c
> +++ b/ui/console.c
> @@ -2333,6 +2333,21 @@ void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
>       dpys[opts->type]->init(ds, opts);
>   }
>   
> +void qemu_display_help(void)
> +{
> +    int idx;
> +
> +    printf("Available display backend types:\n");
> +    for (idx = DISPLAY_TYPE_NONE; idx < DISPLAY_TYPE__MAX; idx++) {
> +        if (!dpys[idx]) {
> +            ui_module_load_one(DisplayType_str(idx));
> +        }
> +        if (dpys[idx]) {
> +            printf("%s\n",  DisplayType_str(dpys[idx]->type));
> +        }
> +    }
> +}
> +
>   void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp)
>   {
>       int val;
> diff --git a/vl.c b/vl.c
> index 86474a55c9..ee15055ba2 100644
> --- a/vl.c
> +++ b/vl.c
> @@ -1869,6 +1869,11 @@ static void parse_display(const char *p)
>   {
>       const char *opts;
>   
> +    if (is_help_option(p)) {
> +        qemu_display_help();
> +        exit(0);
> +    }
> +
>       if (strstart(p, "sdl", &opts)) {
>           /*
>            * sdl DisplayType needs hand-crafted parser instead of
>
Gerd Hoffmann Jan. 9, 2020, 1:21 p.m. UTC | #2
On Wed, Jan 08, 2020 at 03:47:02PM +0100, Thomas Huth wrote:
> We already print availabled devices with "-device help", or available
> backends with "-netdev help" or "-chardev help". Let's provide a way
> for the users to query the available display backends, too.
> 
> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> Signed-off-by: Thomas Huth <thuth@redhat.com>

Added to UI queue.

thanks,
  Gerd
Philippe Mathieu-Daudé Jan. 20, 2020, 12:01 a.m. UTC | #3
Hi Thomas,

On 1/8/20 3:47 PM, Thomas Huth wrote:
> We already print availabled devices with "-device help", or available
> backends with "-netdev help" or "-chardev help". Let's provide a way
> for the users to query the available display backends, too.
> 
> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> Signed-off-by: Thomas Huth <thuth@redhat.com>
> ---
>  v3: Mention -display help in the qemu-doc, too (as suggested by Philippe)
> 
>  include/ui/console.h |  1 +
>  qemu-options.hx      |  3 ++-
>  ui/console.c         | 15 +++++++++++++++
>  vl.c                 |  5 +++++
>  4 files changed, 23 insertions(+), 1 deletion(-)
> 
> diff --git a/include/ui/console.h b/include/ui/console.h
> index 281f9c145b..f35b4fc082 100644
> --- a/include/ui/console.h
> +++ b/include/ui/console.h
> @@ -442,6 +442,7 @@ void qemu_display_register(QemuDisplay *ui);
>  bool qemu_display_find_default(DisplayOptions *opts);
>  void qemu_display_early_init(DisplayOptions *opts);
>  void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
> +void qemu_display_help(void);
>  
>  /* vnc.c */
>  void vnc_display_init(const char *id, Error **errp);
> diff --git a/qemu-options.hx b/qemu-options.hx
> index e9d6231438..d593931664 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -1586,7 +1586,8 @@ STEXI
>  @item -display @var{type}
>  @findex -display
>  Select type of display to use. This option is a replacement for the
> -old style -sdl/-curses/... options. Valid values for @var{type} are
> +old style -sdl/-curses/... options. Use @code{-display help} to list
> +the available display types. Valid values for @var{type} are
>  @table @option
>  @item sdl
>  Display video output via SDL (usually in a separate graphics
> diff --git a/ui/console.c b/ui/console.c
> index ac79d679f5..69339b028b 100644
> --- a/ui/console.c
> +++ b/ui/console.c
> @@ -2333,6 +2333,21 @@ void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
>      dpys[opts->type]->init(ds, opts);
>  }
>  
> +void qemu_display_help(void)
> +{
> +    int idx;
> +
> +    printf("Available display backend types:\n");
> +    for (idx = DISPLAY_TYPE_NONE; idx < DISPLAY_TYPE__MAX; idx++) {
> +        if (!dpys[idx]) {
> +            ui_module_load_one(DisplayType_str(idx));
> +        }
> +        if (dpys[idx]) {
> +            printf("%s\n",  DisplayType_str(dpys[idx]->type));

While listed in the man page, the "none" display is not listed here, any
clue?

> +        }
> +    }
> +}
> +
>  void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp)
>  {
>      int val;
> diff --git a/vl.c b/vl.c
> index 86474a55c9..ee15055ba2 100644
> --- a/vl.c
> +++ b/vl.c
> @@ -1869,6 +1869,11 @@ static void parse_display(const char *p)
>  {
>      const char *opts;
>  
> +    if (is_help_option(p)) {
> +        qemu_display_help();
> +        exit(0);
> +    }
> +
>      if (strstart(p, "sdl", &opts)) {
>          /*
>           * sdl DisplayType needs hand-crafted parser instead of
>
Thomas Huth Jan. 20, 2020, 6:09 a.m. UTC | #4
On 20/01/2020 01.01, Philippe Mathieu-Daudé wrote:
> Hi Thomas,
> 
> On 1/8/20 3:47 PM, Thomas Huth wrote:
>> We already print availabled devices with "-device help", or available
>> backends with "-netdev help" or "-chardev help". Let's provide a way
>> for the users to query the available display backends, too.
>>
>> Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
>> Tested-by: Philippe Mathieu-Daudé <philmd@redhat.com>
>> Signed-off-by: Thomas Huth <thuth@redhat.com>
>> ---
>>  v3: Mention -display help in the qemu-doc, too (as suggested by Philippe)
>>
>>  include/ui/console.h |  1 +
>>  qemu-options.hx      |  3 ++-
>>  ui/console.c         | 15 +++++++++++++++
>>  vl.c                 |  5 +++++
>>  4 files changed, 23 insertions(+), 1 deletion(-)
>>
>> diff --git a/include/ui/console.h b/include/ui/console.h
>> index 281f9c145b..f35b4fc082 100644
>> --- a/include/ui/console.h
>> +++ b/include/ui/console.h
>> @@ -442,6 +442,7 @@ void qemu_display_register(QemuDisplay *ui);
>>  bool qemu_display_find_default(DisplayOptions *opts);
>>  void qemu_display_early_init(DisplayOptions *opts);
>>  void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
>> +void qemu_display_help(void);
>>  
>>  /* vnc.c */
>>  void vnc_display_init(const char *id, Error **errp);
>> diff --git a/qemu-options.hx b/qemu-options.hx
>> index e9d6231438..d593931664 100644
>> --- a/qemu-options.hx
>> +++ b/qemu-options.hx
>> @@ -1586,7 +1586,8 @@ STEXI
>>  @item -display @var{type}
>>  @findex -display
>>  Select type of display to use. This option is a replacement for the
>> -old style -sdl/-curses/... options. Valid values for @var{type} are
>> +old style -sdl/-curses/... options. Use @code{-display help} to list
>> +the available display types. Valid values for @var{type} are
>>  @table @option
>>  @item sdl
>>  Display video output via SDL (usually in a separate graphics
>> diff --git a/ui/console.c b/ui/console.c
>> index ac79d679f5..69339b028b 100644
>> --- a/ui/console.c
>> +++ b/ui/console.c
>> @@ -2333,6 +2333,21 @@ void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
>>      dpys[opts->type]->init(ds, opts);
>>  }
>>  
>> +void qemu_display_help(void)
>> +{
>> +    int idx;
>> +
>> +    printf("Available display backend types:\n");
>> +    for (idx = DISPLAY_TYPE_NONE; idx < DISPLAY_TYPE__MAX; idx++) {
>> +        if (!dpys[idx]) {
>> +            ui_module_load_one(DisplayType_str(idx));
>> +        }
>> +        if (dpys[idx]) {
>> +            printf("%s\n",  DisplayType_str(dpys[idx]->type));
> 
> While listed in the man page, the "none" display is not listed here, any
> clue?

I assume we'd need to print it out manually here since there is no
implementation for this in the dpys array. Care to send a patch?

 Thomas

Patch
diff mbox series

diff --git a/include/ui/console.h b/include/ui/console.h
index 281f9c145b..f35b4fc082 100644
--- a/include/ui/console.h
+++ b/include/ui/console.h
@@ -442,6 +442,7 @@  void qemu_display_register(QemuDisplay *ui);
 bool qemu_display_find_default(DisplayOptions *opts);
 void qemu_display_early_init(DisplayOptions *opts);
 void qemu_display_init(DisplayState *ds, DisplayOptions *opts);
+void qemu_display_help(void);
 
 /* vnc.c */
 void vnc_display_init(const char *id, Error **errp);
diff --git a/qemu-options.hx b/qemu-options.hx
index e9d6231438..d593931664 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -1586,7 +1586,8 @@  STEXI
 @item -display @var{type}
 @findex -display
 Select type of display to use. This option is a replacement for the
-old style -sdl/-curses/... options. Valid values for @var{type} are
+old style -sdl/-curses/... options. Use @code{-display help} to list
+the available display types. Valid values for @var{type} are
 @table @option
 @item sdl
 Display video output via SDL (usually in a separate graphics
diff --git a/ui/console.c b/ui/console.c
index ac79d679f5..69339b028b 100644
--- a/ui/console.c
+++ b/ui/console.c
@@ -2333,6 +2333,21 @@  void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
     dpys[opts->type]->init(ds, opts);
 }
 
+void qemu_display_help(void)
+{
+    int idx;
+
+    printf("Available display backend types:\n");
+    for (idx = DISPLAY_TYPE_NONE; idx < DISPLAY_TYPE__MAX; idx++) {
+        if (!dpys[idx]) {
+            ui_module_load_one(DisplayType_str(idx));
+        }
+        if (dpys[idx]) {
+            printf("%s\n",  DisplayType_str(dpys[idx]->type));
+        }
+    }
+}
+
 void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp)
 {
     int val;
diff --git a/vl.c b/vl.c
index 86474a55c9..ee15055ba2 100644
--- a/vl.c
+++ b/vl.c
@@ -1869,6 +1869,11 @@  static void parse_display(const char *p)
 {
     const char *opts;
 
+    if (is_help_option(p)) {
+        qemu_display_help();
+        exit(0);
+    }
+
     if (strstart(p, "sdl", &opts)) {
         /*
          * sdl DisplayType needs hand-crafted parser instead of