Skip to contentSkip to conversation

ui: Print available display backends with '-display help'

PATCH In review Thomas Huth 4 participants 5 messages Jan 8, 2020 – Jan 20, 2020

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 ui: Print available display backends with '-display help'

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.

---
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(-)
include/ui/console.h +1 -0
index 281f9c145b..f35b4fc082 100644
@@ -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);
qemu-options.hx +2 -1
index e9d6231438..d593931664 100644
@@ -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
ui/console.c +15 -0
index ac79d679f5..69339b028b 100644
@@ -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;
vl.c +5 -0
index 86474a55c9..ee15055ba2 100644
@@ -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
Signature · 1 line
2.18.1
#1 lore raw
Quoted 33 lines · Thomas Huth

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.

---
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(-)
include/ui/console.h +1 -0
index 281f9c145b..f35b4fc082 100644
@@ -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);
qemu-options.hx +0 -0
index e9d6231438..d593931664 100644

qemu-options.hx STEXI · line 1590

Quoted 6 lines
qemu-options.hx +2 -1
@@ -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!

Quoted 46 lines
qemu-options.hx +0 -0
  @table @option
  @item sdl
  Display video output via SDL (usually in a separate graphics
ui/console.c +15 -0
index ac79d679f5..69339b028b 100644
@@ -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;
vl.c +5 -0
index 86474a55c9..ee15055ba2 100644
@@ -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
#3 lore raw
In reply to Thomas Huth

Hi Thomas,

Quoted 51 lines · Thomas Huth

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.

---
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(-)
include/ui/console.h +1 -0
index 281f9c145b..f35b4fc082 100644
@@ -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);
qemu-options.hx +2 -1
index e9d6231438..d593931664 100644
@@ -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
ui/console.c +1 -0
index ac79d679f5..69339b028b 100644
@@ -2333,6 +2333,21 @@ void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
     dpys[opts->type]->init(ds, opts);
 }
 
+void qemu_display_help(void)

ui/console.c void qemu_display_init(DisplayState *ds, DisplayOptions *opts) · line 2346

Quoted 10 lines
ui/console.c +10 -0
+{
+    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?

Quoted 24 lines
ui/console.c +4 -0
+        }
+    }
+}
+
 void qemu_chr_parse_vc(QemuOpts *opts, ChardevBackend *backend, Error **errp)
 {
     int val;
vl.c +5 -0
index 86474a55c9..ee15055ba2 100644
@@ -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
#4 lore raw
Quoted 53 lines · Philippe Mathieu-Daudé

Hi Thomas,

Quoted 50 lines · Thomas Huth

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.

---
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(-)
include/ui/console.h +1 -0
index 281f9c145b..f35b4fc082 100644
@@ -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);
qemu-options.hx +2 -1
index e9d6231438..d593931664 100644
@@ -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
ui/console.c +0 -0
index ac79d679f5..69339b028b 100644
@@ -2333,6 +2333,21 @@ void qemu_display_init(DisplayState *ds, DisplayOptions *opts)
     dpys[opts->type]->init(ds, opts);
 }
 
Quoted 14 lines

ui/console.c void qemu_display_init(DisplayState *ds, DisplayOptions *opts) · line 2346

Quoted 11 lines
ui/console.c +11 -0
+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