External/libvirt
1
0
Fork 0
mirror of https://gitlab.com/libvirt/libvirt.git synced 2024-12-22 05:35:25 +00:00
Code Issues Packages Projects Releases Wiki Activity

virt-admin: Annodate 'unwanted_positional' arguments

Browse Source 
Historically the command parser in virsh parses/fills even optional
arguments with values as if they were positional unless opted out using
VSH_OFLAG_REQ_OPT. This creates unexpected situations when commands can
break in this unwanted semantics:

 $ virsh snapshot-create-as --print-xml 1 2 3
 <domainsnapshot>
   <name>2</name>
   <description>3</description>
 </domainsnapshot>

To prevent any further addition annotate the rest of the arguments with
the 'unwanted_positional' flag, so that the parser can keep parsing them
as such but any further optional argument will not have this behaviour.

Certain arguments where it makes sense are annotated as 'positional' too
in this patch.

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-14 17:17:19 +01:00
parent 100cbccecd
commit a67f737ddf
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tools/virt-admin.c
View File

@ -425,14 +425,17 @@ static const vshCmdOptDef opts_srv_threadpool_set[] = {
}, },
{.name = "min-workers", {.name = "min-workers",
.type = VSH_OT_INT, .type = VSH_OT_INT,
.unwanted_positional = true,
.help = N_("Change bottom limit to number of workers."), .help = N_("Change bottom limit to number of workers."),
}, },
{.name = "max-workers", {.name = "max-workers",
.type = VSH_OT_INT, .type = VSH_OT_INT,
.unwanted_positional = true,
.help = N_("Change upper limit to number of workers."), .help = N_("Change upper limit to number of workers."),
}, },
{.name = "priority-workers", {.name = "priority-workers",
.type = VSH_OT_INT, .type = VSH_OT_INT,
.unwanted_positional = true,
.help = N_("Change the current number of priority workers"), .help = N_("Change the current number of priority workers"),
}, },
{.name = NULL} {.name = NULL}
@ -812,11 +815,13 @@ static const vshCmdOptDef opts_srv_clients_set[] = {
}, },
{.name = "max-clients", {.name = "max-clients",
.type = VSH_OT_INT, .type = VSH_OT_INT,
.unwanted_positional = true,
.help = N_("Change the upper limit to overall number of clients " .help = N_("Change the upper limit to overall number of clients "
"connected to the server."), "connected to the server."),
}, },
{.name = "max-unauth-clients", {.name = "max-unauth-clients",
.type = VSH_OT_INT, .type = VSH_OT_INT,
.unwanted_positional = true,
.help = N_("Change the upper limit to number of clients waiting for " .help = N_("Change the upper limit to number of clients waiting for "
"authentication to be connected to the server"), "authentication to be connected to the server"),
}, },
@ -954,6 +959,7 @@ static const vshCmdInfo info_daemon_log_filters = {
static const vshCmdOptDef opts_daemon_log_filters[] = { static const vshCmdOptDef opts_daemon_log_filters[] = {
{.name = "filters", {.name = "filters",
.type = VSH_OT_STRING, .type = VSH_OT_STRING,
.positional = true,
.help = N_("redefine the existing set of logging filters"), .help = N_("redefine the existing set of logging filters"),
.flags = VSH_OFLAG_EMPTY_OK .flags = VSH_OFLAG_EMPTY_OK
}, },
@ -1037,6 +1043,7 @@ static const vshCmdInfo info_daemon_timeout = {
static const vshCmdOptDef opts_daemon_log_outputs[] = { static const vshCmdOptDef opts_daemon_log_outputs[] = {
{.name = "outputs", {.name = "outputs",
.type = VSH_OT_STRING, .type = VSH_OT_STRING,
.positional = true,
.help = N_("redefine the existing set of logging outputs"), .help = N_("redefine the existing set of logging outputs"),
.flags = VSH_OFLAG_EMPTY_OK .flags = VSH_OFLAG_EMPTY_OK
}, },