All of lore.kernel.org
 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>,
	"Kevin Wolf" <kwolf@redhat.com>
Subject: [Qemu-devel] [PATCH v2 4/5] object: Make option help nicer to read
Date: Fri, 19 Oct 2018 18:49:28 +0200	[thread overview]
Message-ID: <20181019164929.18404-5-mreitz@redhat.com> (raw)
In-Reply-To: <20181019164929.18404-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, add angle brackets
around types, and align the descriptions after 24 characters.

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

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

diff --git a/vl.c b/vl.c
index ac3ed17de4..ecddbb6b8e 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,14 +2729,21 @@ 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) {
+                if (str->len < 24) {
+                    g_string_append_printf(str, "%*s", 24 - (int)str->len, "");
+                }
                 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]);
         }
-- 
2.17.1

  parent reply	other threads:[~2018-10-19 16:50 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-19 16:49 [Qemu-devel] [PATCH v2 0/5] Various option help readability improvement suggestions Max Reitz
2018-10-19 16:49 ` [Qemu-devel] [PATCH v2 1/5] option: Make option help nicer to read Max Reitz
2018-11-05  8:14   ` Marc-André Lureau
2018-10-19 16:49 ` [Qemu-devel] [PATCH v2 2/5] chardev: Indent list of chardevs Max Reitz
2018-11-05  8:14   ` Marc-André Lureau
2018-10-19 16:49 ` [Qemu-devel] [PATCH v2 3/5] qdev-monitor: Make device options help nicer Max Reitz
2018-11-05  8:14   ` Marc-André Lureau
2018-10-19 16:49 ` Max Reitz [this message]
2018-11-05  8:15   ` [Qemu-devel] [PATCH v2 4/5] object: Make option help nicer to read Marc-André Lureau
2018-10-19 16:49 ` [Qemu-devel] [PATCH v2 5/5] fw_cfg: Drop newline in @file description Max Reitz
2018-11-05  8:15   ` Marc-André Lureau
2018-11-05  0:25 ` [Qemu-devel] [PATCH v2 0/5] Various option help readability improvement suggestions Max Reitz
2018-11-05 14:18 ` Kevin Wolf
2018-11-06  0:35   ` Max Reitz

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=20181019164929.18404-5-mreitz@redhat.com \
    --to=mreitz@redhat.com \
    --cc=armbru@redhat.com \
    --cc=kwolf@redhat.com \
    --cc=marcandre.lureau@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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.