From nobody Fri Apr 4 03:24:01 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1740513958; cv=none; d=zohomail.com; s=zohoarc; b=BW4TV9+WbyTjpb8/PyaLiEAV7uLUfVDUaJJ4sYZMqtrz2noJ7T2cczJj+Dhvn1NEZmE6OL+owK0htZFdQXTQHtHi884WKbgxGx1OE2CI3EXnv7F0PeXh5qTApERPdvCNM4z/86wxvulV/lKfk19YPG8ff0WEvJaCjkMzF+K7W0k= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1740513958; h=Content-Type:Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=09Q4SCA56WU4G3UVK6qh0APYbJ3LaCJefw+PR4qAjwg=; b=Hj6AH7tNnMbJ0m8L6o7vVPbo36Ybm9gWbzAh83epR9L2WOsSJOXwDJrvg9m3mmUKuzAECIJRQvwfmw1RdS5p4yLuBaczAiWhLeEjVy7dADBLjHZ70MTXmWqC/q8HouisFHbBuS7vJlM1hRRLouDWXSo4YSkBSc1egXT1dpORcVs= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1740513958170679.043664334153; Tue, 25 Feb 2025 12:05:58 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tn1Aj-0005bY-4q; Tue, 25 Feb 2025 15:04:53 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tn1Ad-0005aD-Dl for qemu-devel@nongnu.org; Tue, 25 Feb 2025 15:04:47 -0500 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tn1Ab-00042s-3z for qemu-devel@nongnu.org; Tue, 25 Feb 2025 15:04:47 -0500 Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-455-ROEKn9LYNXKBhgVf1szp5w-1; Tue, 25 Feb 2025 15:04:40 -0500 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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 mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id F2D3A180087A; Tue, 25 Feb 2025 20:04:37 +0000 (UTC) Received: from toolbx.redhat.com (unknown [10.42.28.59]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 77A0A1800378; Tue, 25 Feb 2025 20:04:34 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1740513883; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=09Q4SCA56WU4G3UVK6qh0APYbJ3LaCJefw+PR4qAjwg=; b=RvnSWPwcZrr6ZnHbjEkV8neVs+xB8MZRvixpc8Y9DCvE8oPNoygjEWjt4MjOeMzhdoA5nT /e7NkghuOzEy3QZpp8WILHAFAnvse/YzWu6NlQKI5XkzhGz2LDmLuGvgOa9wAMp0ibsjgj nD9bPKYEw8Sdiq8qhZO1UmHMoF0xOi8= X-MC-Unique: ROEKn9LYNXKBhgVf1szp5w-1 X-Mimecast-MFC-AGG-ID: ROEKn9LYNXKBhgVf1szp5w_1740513879 From: =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= To: qemu-devel@nongnu.org Cc: Eduardo Habkost , Marcel Apfelbaum , "Michael S. Tsirkin" , Zhao Liu , Yanan Wang , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Peter Maydell , Thomas Huth , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PATCH 2/4] docs/about/deprecated: auto-generate a note for versioned machine types Date: Tue, 25 Feb 2025 20:04:21 +0000 Message-ID: <20250225200423.2350471-3-berrange@redhat.com> In-Reply-To: <20250225200423.2350471-1-berrange@redhat.com> References: <20250225200423.2350471-1-berrange@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=berrange@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -24 X-Spam_score: -2.5 X-Spam_bar: -- X-Spam_report: (-2.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.443, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H5=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_VALIDITY_CERTIFIED_BLOCKED=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1740513960225019000 We deprecate versioned machine types on a fixed schedule. This allows us to auto-generate a paragraph in the deprecated.rst document that always has accurate version info. Signed-off-by: Daniel P. Berrang=C3=A9 --- docs/about/deprecated.rst | 7 +++++++ docs/conf.py | 33 ++++++++++++++++++++++++++++++++- 2 files changed, 39 insertions(+), 1 deletion(-) diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst index abadf8de27..da2b1b48ca 100644 --- a/docs/about/deprecated.rst +++ b/docs/about/deprecated.rst @@ -269,6 +269,13 @@ Use ``Sun-UltraSparc-IIIi-plus`` and ``Sun-UltraSparc-= IV-plus`` instead. System emulator machines ------------------------ =20 +Versioned machine types (aarch64, arm, i386, m68k, ppc, ppc64, s390x, x86_= 64) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''= ''' + +In accordance with our versioned machine type deprecation policy, all mach= ine +types with version |VER_MACHINE_DEPRECATION_VERSION|, or older, have been +deprecated. + Arm ``virt`` machine ``dtb-kaslr-seed`` property (since 7.1) '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 diff --git a/docs/conf.py b/docs/conf.py index 31bb9a3789..421ece1024 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -110,6 +110,27 @@ else: version =3D release =3D "unknown version" =20 +bits =3D version.split(".") + +major =3D int(bits[0]) +minor =3D int(bits[1]) +micro =3D int(bits[2]) + +# Check for a dev snapshot, so we can adjust to next +# predicted release version. +# +# This assumes we do 3 releases per year, so must bump +# major if minor =3D=3D 2 +if micro >=3D 50: + micro =3D 0 + if minor =3D=3D 2: + major +=3D 1 + minor =3D 0 + else: + minor +=3D 1 + +ver_machine_deprecation_version =3D "%d.%d.%d" % (major - 3, minor, micro) + # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -138,7 +159,17 @@ # environment variable is not set is for the benefit of readthedocs # style document building; our Makefile always sets the variable. confdir =3D os.getenv('CONFDIR', "/etc/qemu") -rst_epilog =3D ".. |CONFDIR| replace:: ``" + confdir + "``\n" + +vars =3D { + "CONFDIR": confdir, + "VER_MACHINE_DEPRECATION_VERSION": ver_machine_deprecation_version, +} + +rst_epilog =3D "".join([ + ".. |" + key + "| replace:: ``" + vars[key] + "``\n" + for key in vars.keys() +]) + # We slurp in the defs.rst.inc and literally include it into rst_epilog, # because Sphinx's include:: directive doesn't work with absolute paths # and there isn't any one single relative path that will work for all --=20 2.47.1