From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <t.lamprecht@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id 3A2066C229
 for <pbs-devel@lists.proxmox.com>; Wed, 22 Sep 2021 08:00:16 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id 349D71555B
 for <pbs-devel@lists.proxmox.com>; Wed, 22 Sep 2021 07:59:46 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
 [94.136.29.106])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS id AE29115550
 for <pbs-devel@lists.proxmox.com>; Wed, 22 Sep 2021 07:59:45 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
 by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 7C6AF4459F
 for <pbs-devel@lists.proxmox.com>; Wed, 22 Sep 2021 07:59:45 +0200 (CEST)
Message-ID: <f861230d-b96e-a199-a027-a30d65d35650@proxmox.com>
Date: Wed, 22 Sep 2021 07:58:54 +0200
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:93.0) Gecko/20100101
 Thunderbird/93.0
Content-Language: en-US
To: Proxmox Backup Server development discussion <pbs-devel@lists.proxmox.com>,
 =?UTF-8?Q?Fabian_Gr=c3=bcnbichler?= <f.gruenbichler@proxmox.com>
References: <20210915133634.4149021-1-f.gruenbichler@proxmox.com>
From: Thomas Lamprecht <t.lamprecht@proxmox.com>
In-Reply-To: <20210915133634.4149021-1-f.gruenbichler@proxmox.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: quoted-printable
X-SPAM-LEVEL: Spam detection results:  0
 AWL 0.252 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
 http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
 information. [format.rs]
Subject: [pbs-devel] applied: [RFC proxmox 1/2] schema: print item type-text
 instead of <array>
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
 <pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>, 
 <mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>, 
 <mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Wed, 22 Sep 2021 06:00:16 -0000

On 15.09.21 15:36, Fabian Gr=C3=BCnbichler wrote:
> this is only used for CLI synopsis/usage strings, the API viewer alread=
y
> prints the full type text in a correct format. the old variant was also=

> rather misleading, since on the CLI we don't pass in an array, but each=

> item as its own parameter.
>=20
> Signed-off-by: Fabian Gr=C3=BCnbichler <f.gruenbichler@proxmox.com>
> ---
> noticed this while working on the pull/sync filtering series, but it
> affects quite a lot of stuff, among other things the Updater/Deleteable=

> CLI, e.g. from `man proxmox-backup-manager`:
>=20
>        --delete <array>
>                      List of properties to delete.
>=20
> vs.
>=20
>        --delete disable|validation-delay
>                      List of properties to delete.
>=20
> but some of them might only have <string> as the item type text, which
> is not much nicer :-/
>=20
> the whole "List of .." is confusing anyway, but not easily solvable,
> since the description is used for
> - API dump/viewer (where it is a list/array of ..)
> - usage message/man pages (where it's a parameter that gives a single
>   element, but it might be passed in multiple times to construct an
>   array)
>=20
> also for some common occurences, the item description is too generic,
> and it's not possible to override the description for external types
> with the current api macro.
>=20
>  proxmox/src/api/format.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>=20
>

applied, thanks! FYI: I moved most of the diff-stat text to the commit me=
ssage,
slightly cleaned up. IMO it gives better context.