From nobody Mon Feb 9 00:08:10 2026 Delivered-To: importer@patchew.org Received-SPF: none (zohomail.com: 8.43.85.245 is neither permitted nor denied by domain of lists.libvirt.org) client-ip=8.43.85.245; envelope-from=devel-bounces@lists.libvirt.org; helo=lists.libvirt.org; Authentication-Results: mx.zohomail.com; spf=none (zohomail.com: 8.43.85.245 is neither permitted nor denied by domain of lists.libvirt.org) smtp.mailfrom=devel-bounces@lists.libvirt.org; dmarc=fail(p=none dis=none) header.from=redhat.com Return-Path: Received: from lists.libvirt.org (lists.libvirt.org [8.43.85.245]) by mx.zohomail.com with SMTPS id 1710510660199284.84002341214796; Fri, 15 Mar 2024 06:51:00 -0700 (PDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 0BF4A2140; Fri, 15 Mar 2024 09:50:58 -0400 (EDT) Received: from lists.libvirt.org (localhost [IPv6:::1]) by lists.libvirt.org (Postfix) with ESMTP id 616361A99; Fri, 15 Mar 2024 09:45:05 -0400 (EDT) Received: by lists.libvirt.org (Postfix, from userid 996) id 63E301AE1; Fri, 15 Mar 2024 09:44:49 -0400 (EDT) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by lists.libvirt.org (Postfix) with ESMTPS id A4EFA1A85 for ; Fri, 15 Mar 2024 09:44:34 -0400 (EDT) Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-331-2v4mbDxYOvWmNUjeFDQK0w-1; Fri, 15 Mar 2024 09:44:32 -0400 Received: from smtp.corp.redhat.com (int-mx08.intmail.prod.int.rdu2.redhat.com [10.11.54.8]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id A1334185A786 for ; Fri, 15 Mar 2024 13:44:32 +0000 (UTC) Received: from speedmetal.lan (unknown [10.45.242.5]) by smtp.corp.redhat.com (Postfix) with ESMTP id 1B7CCC1576F for ; Fri, 15 Mar 2024 13:44:31 +0000 (UTC) X-Spam-Checker-Version: SpamAssassin 3.4.4 (2020-01-24) on lists.libvirt.org X-Spam-Level: X-Spam-Status: No, score=-0.8 required=5.0 tests=HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_DNSWL_NONE,RCVD_IN_MSPIKE_H4, RCVD_IN_MSPIKE_WL,SPF_HELO_NONE,T_SCC_BODY_TEXT_LINE autolearn=unavailable autolearn_force=no version=3.4.4 X-MC-Unique: 2v4mbDxYOvWmNUjeFDQK0w-1 From: Peter Krempa To: devel@lists.libvirt.org Subject: [PATCH 08/28] vsh: Introduce annotation for vsh options which are unexpectedly parsed positionally Date: Fri, 15 Mar 2024 14:44:03 +0100 Message-ID: In-Reply-To: References: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.8 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Message-ID-Hash: GAIBJ4YD2J6ATKGR4OD4VD7ZFACWPMGK X-Message-ID-Hash: GAIBJ4YD2J6ATKGR4OD4VD7ZFACWPMGK X-MailFrom: pkrempa@redhat.com X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-config-1; header-match-config-2; header-match-config-3; header-match-devel.lists.libvirt.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; suspicious-header X-Mailman-Version: 3.2.2 Precedence: list List-Id: Development discussions about the libvirt library & tools Archived-At: List-Archive: List-Help: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-ZM-MESSAGEID: 1710510660457100001 Based on the rationale in previous commit, all commands which were parsed as positional but not documented as such will be annotated with this flag. Signed-off-by: Peter Krempa --- tools/vsh.c | 12 ++++++++++-- tools/vsh.h | 7 +++++++ 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/tools/vsh.c b/tools/vsh.c index 96d6a5c238..eeee58d39e 100644 --- a/tools/vsh.c +++ b/tools/vsh.c @@ -334,7 +334,8 @@ vshCmddefCheckInternals(vshControl *ctl, case VSH_OT_ARGV: if (brokenPositionals =3D=3D 0 || brokenPositionals =3D=3D opt->type) { - if (!(opt->flags & VSH_OFLAG_REQ_OPT) && !opt->positio= nal) + if (!(opt->flags & VSH_OFLAG_REQ_OPT) && + !(opt->positional || opt->unwanted_positional)) virBufferStrcat(&posbuf, opt->name, ", ", NULL); } break; @@ -363,6 +364,12 @@ vshCmddefCheckInternals(vshControl *ctl, return -1; } + if (opt->unwanted_positional && opt->positional) { + vshError(ctl, "unwanted_positional flag of argument '%s' of co= mmand '%s' must not be used together with positional", + opt->name, cmd->name); + return -1; + } + switch (opt->type) { case VSH_OT_NONE: vshError(ctl, "invalid type 'NONE' of option '%s' of command '= %s'", @@ -376,7 +383,7 @@ vshCmddefCheckInternals(vshControl *ctl, return -1; } - if (opt->positional) { + if (opt->positional || opt->unwanted_positional) { vshError(ctl, "boolean parameter '%s' of command '%s' must= not be positional", opt->name, cmd->name); return -1; @@ -397,6 +404,7 @@ vshCmddefCheckInternals(vshControl *ctl, if (opt->required || opt->positional || + opt->unwanted_positional || opt->completer || opt->flags || !opt->help) { diff --git a/tools/vsh.h b/tools/vsh.h index cd833a55fa..fdcc89b12a 100644 --- a/tools/vsh.h +++ b/tools/vsh.h @@ -133,6 +133,13 @@ struct _vshCmdOptDef { vshCmdOptType type; /* option type */ bool required; /* option is required */ bool positional; /* option is a positional option (not requ= iring '--optionname') */ + + /* Historically the command parser in virsh allowed many optional argu= ments + * which were documented as non-positional to be filled positionally. = To + * preserve this functionality those need to be annotated with the + * 'unwanted_positional' flag. New options must not use this flag */ + bool unwanted_positional; + unsigned int flags; /* flags */ const char *help; /* non-NULL help string; or for VSH_OT_ALI= AS * the name of a later public option */ --=20 2.44.0 _______________________________________________ Devel mailing list -- devel@lists.libvirt.org To unsubscribe send an email to devel-leave@lists.libvirt.org