qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Max Reitz <mreitz@redhat.com>
To: qemu-block@nongnu.org
Cc: qemu-devel@nongnu.org, "Max Reitz" <mreitz@redhat.com>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Markus Armbruster" <armbru@redhat.com>,
	"Paolo Bonzini" <pbonzini@redhat.com>
Subject: [Qemu-devel] [PATCH 4/5] object: Make option help nicer to read
Date: Mon, 15 Oct 2018 19:28:16 +0200	[thread overview]
Message-ID: <20181015172817.19796-5-mreitz@redhat.com> (raw)
In-Reply-To: <20181015172817.19796-1-mreitz@redhat.com>

Just like in qemu_opts_print_help(), print the object name as a caption
instead of on every single line, indent all options, and replace the '='
by ': '.

Also, indent every object name in the list of available objects.

Signed-off-by: Max Reitz <mreitz@redhat.com>
---
 vl.c | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/vl.c b/vl.c
index 4e25c78bff..f9ed053eab 100644
--- a/vl.c
+++ b/vl.c
@@ -2707,7 +2707,7 @@ static bool object_create_initial(const char *type, QemuOpts *opts)
         list = object_class_get_list_sorted(TYPE_USER_CREATABLE, false);
         for (l = list; l != NULL; l = l->next) {
             ObjectClass *oc = OBJECT_CLASS(l->data);
-            printf("%s\n", object_class_get_name(oc));
+            printf("  %s\n", object_class_get_name(oc));
         }
         g_slist_free(list);
         exit(0);
@@ -2729,16 +2729,20 @@ static bool object_create_initial(const char *type, QemuOpts *opts)
             }
 
             str = g_string_new(NULL);
-            g_string_append_printf(str, "%s.%s=%s", type,
-                                   prop->name, prop->type);
+            g_string_append_printf(str, "%s: %s", prop->name, prop->type);
             if (prop->description) {
                 g_string_append_printf(str, " - %s", prop->description);
             }
             g_ptr_array_add(array, g_string_free(str, false));
         }
         g_ptr_array_sort(array, (GCompareFunc)qemu_pstrcmp0);
+        if (array->len > 0) {
+            printf("%s options:\n", type);
+        } else {
+            printf("There are no options for %s.\n", type);
+        }
         for (i = 0; i < array->len; i++) {
-            printf("%s\n", (char *)array->pdata[i]);
+            printf("  %s\n", (char *)array->pdata[i]);
         }
         g_ptr_array_set_free_func(array, g_free);
         g_ptr_array_free(array, true);
-- 
2.17.1

  parent reply	other threads:[~2018-10-15 17:28 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-15 17:28 [Qemu-devel] [PATCH 0/5] Various option help readability improvement suggestions Max Reitz
2018-10-15 17:28 ` [Qemu-devel] [PATCH 1/5] option: Make option help nicer to read Max Reitz
2018-10-16  6:46   ` Marc-André Lureau
2018-10-19  9:59     ` Max Reitz
2018-10-16 12:12   ` [Qemu-devel] [Qemu-block] " Kevin Wolf
2018-10-19 10:00     ` Max Reitz
2018-10-17  6:50   ` [Qemu-devel] " Markus Armbruster
2018-10-19 10:00     ` Max Reitz
2018-10-15 17:28 ` [Qemu-devel] [PATCH 2/5] chardev: Indent list of chardevs Max Reitz
2018-10-15 17:28 ` [Qemu-devel] [PATCH 3/5] qdev-monitor: Make device options help nicer Max Reitz
2018-10-15 17:28 ` Max Reitz [this message]
2018-10-15 17:28 ` [Qemu-devel] [PATCH 5/5] fw_cfg: Drop newline in @file description Max Reitz
2018-10-15 22:31   ` Philippe Mathieu-Daudé

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20181015172817.19796-5-mreitz@redhat.com \
    --to=mreitz@redhat.com \
    --cc=armbru@redhat.com \
    --cc=marcandre.lureau@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-block@nongnu.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).