From: Peter Krempa <pkrempa@redhat.com>
Date: Wed, 13 Mar 2024 15:58:52 +0000 (+0100)
Subject: vsh: Fix option formatting for 'VHS_OT_ARGV' options
X-Git-Tag: v10.3.0-rc1~129
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=baa20d6eb8312af5c741bcd662657e6e5e62f63c;p=thirdparty%2Flibvirt.git

vsh: Fix option formatting for 'VHS_OT_ARGV' options

While previous fixes kept the help output unchanged as base for the
refactors it turns out that the formatting of help for argv options is
wrong.

Specifically in SYNOPSIS the non-positional _ARGV would have the option
name in square brackets (which in other cases means that given thing is
optional) despite being required.

Similarly in the DESCRIPTION section positional versions would not show
the optional argument name and also didn't use the three dots to signal
that it can be used multiple times.

Signed-off-by: Peter Krempa <pkrempa@redhat.com>
Reviewed-by: Ján Tomko <jtomko@redhat.com>
---

diff --git a/tools/vsh.c b/tools/vsh.c
index eeee58d39e..cbddc5ed92 100644
--- a/tools/vsh.c
+++ b/tools/vsh.c
@@ -714,9 +714,9 @@ vshCmddefHelp(const vshCmdDef *def)
                     }
                 } else {
                     if (opt->required) {
-                        fprintf(stdout, _(" {[--%1$s] <string>}..."), opt->name);
+                        fprintf(stdout, _(" --%1$s <string>..."), opt->name);
                     } else {
-                        fprintf(stdout, _(" [[--%1$s] <string>]..."), opt->name);
+                        fprintf(stdout, _(" [--%1$s <string>]..."), opt->name);
                     }
                 }
                 break;
@@ -765,9 +765,9 @@ vshCmddefHelp(const vshCmdDef *def)
 
             case VSH_OT_ARGV:
                 if (opt->positional) {
-                    optstr = g_strdup_printf("<%s>", opt->name);
+                    optstr = g_strdup_printf(_("[--%1$s] <string>..."), opt->name);
                 } else {
-                    optstr = g_strdup_printf(_("[--%1$s] <string>"), opt->name);
+                    optstr = g_strdup_printf(_("--%1$s <string>..."), opt->name);
                 }
                 break;