openkylin
/
libvirt
mirror of https://gitee.com/openkylin/libvirt.git
9
0
Fork 0
Code Issues Projects Releases Wiki Activity

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>
This commit is contained in:
Peter Krempa 2024-03-13 16:58:52 +01:00
parent e9e3d6dff4
commit baa20d6eb8
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
tools/vsh.c
View File

@ -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;