From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <pve-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
	by lore.proxmox.com (Postfix) with ESMTPS id 7B38F1FF189
	for <inbox@lore.proxmox.com>; Fri,  4 Apr 2025 14:05:33 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
	by firstgate.proxmox.com (Proxmox) with ESMTP id 19D391DAD8;
	Fri,  4 Apr 2025 14:05:19 +0200 (CEST)
Message-ID: <00de5150-d2ce-402e-bea9-b8bbec7c1d22@proxmox.com>
Date: Fri, 4 Apr 2025 14:04:45 +0200
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>,
 Dominik Csapak <d.csapak@proxmox.com>
References: <20250307144436.122621-1-d.csapak@proxmox.com>
 <20250307144436.122621-9-d.csapak@proxmox.com>
Content-Language: en-US
From: Fiona Ebner <f.ebner@proxmox.com>
In-Reply-To: <20250307144436.122621-9-d.csapak@proxmox.com>
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.037 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to
 Validity was blocked. See
 https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more
 information.
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
Subject: Re: [pve-devel] [PATCH qemu-server v2 8/8] api: qemu machine
 capabilities: add description for pveX variants
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox VE development discussion <pve-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pve-devel-bounces@lists.proxmox.com
Sender: "pve-devel" <pve-devel-bounces@lists.proxmox.com>

Am 07.03.25 um 15:44 schrieb Dominik Csapak:
> and retroactively add descriptions for previous bumps.
> 
> Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
> ---
> new in v2
>  PVE/API2/Qemu/Machine.pm  |  9 +++++++++
>  PVE/QemuServer/Machine.pm | 15 +++++++++++++++
>  2 files changed, 24 insertions(+)
> 
> diff --git a/PVE/API2/Qemu/Machine.pm b/PVE/API2/Qemu/Machine.pm
> index 11eba34b..d9aaa6af 100644
> --- a/PVE/API2/Qemu/Machine.pm
> +++ b/PVE/API2/Qemu/Machine.pm
> @@ -46,6 +46,11 @@ __PACKAGE__->register_method({
>  		    type => 'string',
>  		    description => "The machine version.",
>  		},
> +		description => {
> +		    type => 'string',
> +		    optional => 1,
> +		    description => 'Notable changes that version introduces, only used for +pveX versions.',

Style nit: line too long.

> +		},
>  	    },
>  	},
>      },
> @@ -67,6 +72,10 @@ __PACKAGE__->register_method({
>  			version => $version,
>  		    };
>  
> +		    if (my $description = PVE::QemuServer::Machine::get_pve_version_description($version)) {

Style nit: line too long. Maybe have the function call be its own line
and then test the variable (can also be post-if then).

> +			$entry->{description} = $description;
> +		    }
> +
>  		    push $to_add->@*, $entry;
>  		}
>  	    }
> diff --git a/PVE/QemuServer/Machine.pm b/PVE/QemuServer/Machine.pm
> index 9864d401..f4b2d099 100644
> --- a/PVE/QemuServer/Machine.pm
> +++ b/PVE/QemuServer/Machine.pm
> @@ -15,6 +15,21 @@ our $PVE_MACHINE_VERSION = {
>      '9.2' => 1,
>  };
>  
> +# When bumping the pveX version, add a description why.
> +my $PVE_MACHINE_VERSION_DESCRIPTIONS = {
> +    '4.1+pve1' => 'Introduction of pveX versioning, no changes.',
> +    '4.1+pve2' => 'Increases supported SCSI drive count.',
> +    '9.2+pve1' => 'Disables S3/S4 power states.',
> +};
> +
> +# returns the description of a given machine version with pve version, e.g. 9.2+pve1 or undef if
> +# there is none
> +sub get_pve_version_description {
> +    my ($version) = @_;
> +
> +    return $PVE_MACHINE_VERSION_DESCRIPTIONS->{$version};
> +}
> +
>  my $machine_fmt = {
>      type => {
>  	default_key => 1,



_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel