From nobody Fri May 3 02:04:46 2024 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=1629890120; cv=none; d=zohomail.com; s=zohoarc; b=cy0lfz57F38Rh3UqQCErqkCwRkTc4aTQp2oLDwtUzTqtZU7RWtbLJKLX9CEAqouOmQwNho33h05zbNF8WRrXrKm0FnyD7Mij7V+QKoP76Xe+6LTbfn1eGJSID19G+3/Yt493hlQR0RJ+G0oPchR+iWnI1WS6oQjazEM1E4IIv4g= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629890120; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=F6GGmholXce/jmshIj3aM2wC9Cu1U7pcQ2HOug7EZ3Y=; b=a0JDDVafK1mK/0nBoLarq/cWufqkHGqhuPWZLSb/SPGQicjYB41Nr7qU4Fb34MyGBd5Ld/LVMXuWtRbaEqdskd1M8S/aNrAKDMlbK4/tBRxvWZf0ZMrOkstA0St9eSt+niUZpwdNTkkMBuETDb1ZxH5nIKybYgCUhUtmicWArgk= 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 1629890120641918.0769090062507; Wed, 25 Aug 2021 04:15:20 -0700 (PDT) Received: from localhost ([::1]:38036 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIqsJ-0008Br-BP for importer@patchew.org; Wed, 25 Aug 2021 07:15:19 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53596) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe1-0007ki-4i for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:33 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:20284) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqdz-0004iq-Gn for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:32 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-385-8O6manzzNUWatuuO2Nv_yg-1; Wed, 25 Aug 2021 07:00:29 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 3BEC51018F72; Wed, 25 Aug 2021 11:00:28 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.111]) by smtp.corp.redhat.com (Postfix) with ESMTP id 5F6D15D741; Wed, 25 Aug 2021 11:00:27 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629889230; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=F6GGmholXce/jmshIj3aM2wC9Cu1U7pcQ2HOug7EZ3Y=; b=WqJ1EWPLWqEEcSpsblO2YJGJ7DAfvAuocyH5uQhehYaNen8mIjocjFr85ry7pPDn73OmF7 1xt1mIhy/XZRaDXKP3U0LZnc6q87R20pgn+IAD+R+K212344tP818ycLboIfVclSM48aEh Dt1cQdfmI0A/A4l3jHo7tDlWxb3aLZc= X-MC-Unique: 8O6manzzNUWatuuO2Nv_yg-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 1/6] docs/about: Remove the duplicated doc Date: Wed, 25 Aug 2021 13:00:13 +0200 Message-Id: <20210825110018.100913-2-thuth@redhat.com> In-Reply-To: <20210825110018.100913-1-thuth@redhat.com> References: <20210825110018.100913-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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=216.205.24.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.745, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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.23 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" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629890122167100001 Content-Type: text/plain; charset="utf-8" From: Yanan Wang There are two places describing the same thing about deprecation of invalid topologies of -smp CLI, so remove the duplicated one. Signed-off-by: Yanan Wang Reviewed-by: Cornelia Huck Reviewed-by: Andrew Jones Reviewed-by: Thomas Huth Message-Id: <20210823030005.165668-2-wangyanan55@huawei.com> Signed-off-by: Thomas Huth --- docs/about/removed-features.rst | 13 ------------- 1 file changed, 13 deletions(-) diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.= rst index cbfa1a8e31..6a9c5bb484 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -647,19 +647,6 @@ as ignored. Currently, users are responsible for makin= g sure the backing storage specified with ``-mem-path`` can actually provide the guest RAM configured= with ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful. =20 -``-smp`` (invalid topologies) (removed 5.2) -''''''''''''''''''''''''''''''''''''''''''' - -CPU topology properties should describe whole machine topology including -possible CPUs. - -However, historically it was possible to start QEMU with an incorrect topo= logy -where *n* <=3D *sockets* * *cores* * *threads* < *maxcpus*, -which could lead to an incorrect topology enumeration by the guest. -Support for invalid topologies is removed, the user must ensure -topologies described with -smp include all possible cpus, i.e. -*sockets* * *cores* * *threads* =3D *maxcpus*. - ``-machine enforce-config-section=3Don|off`` (removed 5.2) '''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 --=20 2.27.0 From nobody Fri May 3 02:04:46 2024 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=1629890063; cv=none; d=zohomail.com; s=zohoarc; b=oGRrD9cjJgt5sLbdfaNF7JtZwk4nRHLI05E+/caPZGkRHA7KiEFe2AnEUIIZwsPsBlnDY9+wYIRUcgoGjDFl2+U3LdmqQb5ysf1M+/zxPB6OxE0Yi5Go2nG2lRRjsbOLl+GfbBqhPPjqX2+PZI1mGe6r71U4ZupFG7uw1/PaBYc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629890063; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=tuoUgT7RjMCkI5dtCkxWPhJrJoCi2Db56YGJzBnAGzY=; b=ef1djBrVEg+vAiZQfO899cos1qUHOmaReVdwrd3VOe86iLmF+2dPO0ad8SRr59IQS6njvRNuDJ7lIrJMD3kJQIVVUdvfXYG2F71/H7ptm3hYB1r6Tl+mLkWYeXTWm/n8Ri194CxSp7705jq8Pza/DF8IjPsx6pPQ+GySPKLLuRc= 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 1629890063501351.0144337241312; Wed, 25 Aug 2021 04:14:23 -0700 (PDT) Received: from localhost ([::1]:33502 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIqrO-00058J-AE for importer@patchew.org; Wed, 25 Aug 2021 07:14:22 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53624) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe3-0007su-Pl for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:35 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:24777) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe1-0004ja-E8 for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:35 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-273-PAgn9wASMCqTvx9GMZu8uA-1; Wed, 25 Aug 2021 07:00:30 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7685992500; Wed, 25 Aug 2021 11:00:29 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.111]) by smtp.corp.redhat.com (Postfix) with ESMTP id 8DF765D741; Wed, 25 Aug 2021 11:00:28 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629889232; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=tuoUgT7RjMCkI5dtCkxWPhJrJoCi2Db56YGJzBnAGzY=; b=Mh5HdoFAGwjsDFp6e7WCnGjCRWxz2sGNcTteBEVlhizHZ1cvDMm0M7J14N+Bm6EcqgkxG+ QO/DNFjgyd2vKfr7H0/KCo+qXkQ6qAgNNS6XPagW0501rqX7hDPtjTZ4pwpJoiK48ewcK4 KMccCCjfpKQGBO7gYquwNKLTrJGEqv4= X-MC-Unique: PAgn9wASMCqTvx9GMZu8uA-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 2/6] docs/about: Unify the subject format Date: Wed, 25 Aug 2021 13:00:14 +0200 Message-Id: <20210825110018.100913-3-thuth@redhat.com> In-Reply-To: <20210825110018.100913-1-thuth@redhat.com> References: <20210825110018.100913-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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=216.205.24.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.745, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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.23 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" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629890065039100001 Content-Type: text/plain; charset="utf-8" From: Yanan Wang There is a mixture of "since/removed in X.Y" vs "since/removed in X.Y.Z" in the subjects in deprecated.rst/removed-features.rst. It will be better to use an unified format. It seems unlikely that we will ever deprecate something in a stable release, and even more unlikely that we'll remove something in one, so the short versions look like the thing we want to standardize on. So here we unify the subject format in deprecated.rst to "since X.Y", and unify the subject format in removed-features.rst to "removed in X.Y". Signed-off-by: Yanan Wang Reviewed-by: Cornelia Huck Reviewed-by: Andrew Jones Reviewed-by: Thomas Huth Message-Id: <20210823030005.165668-3-wangyanan55@huawei.com> Signed-off-by: Thomas Huth --- docs/about/deprecated.rst | 56 ++++++++++++++++----------------- docs/about/removed-features.rst | 28 ++++++++--------- 2 files changed, 42 insertions(+), 42 deletions(-) diff --git a/docs/about/deprecated.rst b/docs/about/deprecated.rst index 6d438f1c8d..8d4fd384a5 100644 --- a/docs/about/deprecated.rst +++ b/docs/about/deprecated.rst @@ -107,8 +107,8 @@ the process listing. This is replaced by the new ``pass= word-secret`` option which lets the password be securely provided on the command line using a ``secret`` object instance. =20 -``opened`` property of ``rng-*`` objects (since 6.0.0) -'''''''''''''''''''''''''''''''''''''''''''''''''''''' +``opened`` property of ``rng-*`` objects (since 6.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''' =20 The only effect of specifying ``opened=3Don`` in the command line or QMP ``object-add`` is that the device is opened immediately, possibly before a= ll @@ -116,8 +116,8 @@ other options have been processed. This will either ha= ve no effect (if ``opened`` was the last option) or cause errors. The property is therefore useless and should not be specified. =20 -``loaded`` property of ``secret`` and ``secret_keyring`` objects (since 6.= 0.0) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''= '''' +``loaded`` property of ``secret`` and ``secret_keyring`` objects (since 6.= 0) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''= '' =20 The only effect of specifying ``loaded=3Don`` in the command line or QMP ``object-add`` is that the secret is loaded immediately, possibly before a= ll @@ -142,33 +142,33 @@ should be used instead. QEMU Machine Protocol (QMP) commands ------------------------------------ =20 -``blockdev-open-tray``, ``blockdev-close-tray`` argument ``device`` (since= 2.8.0) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''= ''''''' +``blockdev-open-tray``, ``blockdev-close-tray`` argument ``device`` (since= 2.8) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''= ''''' =20 Use argument ``id`` instead. =20 -``eject`` argument ``device`` (since 2.8.0) -''''''''''''''''''''''''''''''''''''''''''' +``eject`` argument ``device`` (since 2.8) +''''''''''''''''''''''''''''''''''''''''' =20 Use argument ``id`` instead. =20 -``blockdev-change-medium`` argument ``device`` (since 2.8.0) -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``blockdev-change-medium`` argument ``device`` (since 2.8) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 Use argument ``id`` instead. =20 -``block_set_io_throttle`` argument ``device`` (since 2.8.0) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``block_set_io_throttle`` argument ``device`` (since 2.8) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 Use argument ``id`` instead. =20 -``blockdev-add`` empty string argument ``backing`` (since 2.10.0) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``blockdev-add`` empty string argument ``backing`` (since 2.10) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 Use argument value ``null`` instead. =20 -``block-commit`` arguments ``base`` and ``top`` (since 3.1.0) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``block-commit`` arguments ``base`` and ``top`` (since 3.1) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 Use arguments ``base-node`` and ``top-node`` instead. =20 @@ -191,8 +191,8 @@ from Linux upstream kernel, declare it deprecated. System emulator CPUS -------------------- =20 -``Icelake-Client`` CPU Model (since 5.2.0) -'''''''''''''''''''''''''''''''''''''''''' +``Icelake-Client`` CPU Model (since 5.2) +'''''''''''''''''''''''''''''''''''''''' =20 ``Icelake-Client`` CPU Models are deprecated. Use ``Icelake-Server`` CPU Models instead. @@ -245,8 +245,8 @@ Device options Emulated device options ''''''''''''''''''''''' =20 -``-device virtio-blk,scsi=3Don|off`` (since 5.0.0) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +``-device virtio-blk,scsi=3Don|off`` (since 5.0) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =20 The virtio-blk SCSI passthrough feature is a legacy VIRTIO feature. VIRTI= O 1.0 and later do not support it because the virtio-scsi device was introduced = for @@ -258,14 +258,14 @@ alias. Block device options '''''''''''''''''''' =20 -``"backing": ""`` (since 2.12.0) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +``"backing": ""`` (since 2.12) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =20 In order to prevent QEMU from automatically opening an image's backing chain, use ``"backing": null`` instead. =20 -``rbd`` keyvalue pair encoded filenames: ``""`` (since 3.1.0) -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +``rbd`` keyvalue pair encoded filenames: ``""`` (since 3.1) +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =20 Options for ``rbd`` should be specified according to its runtime options, like other block drivers. Legacy parsing of keyvalue pair encoded @@ -283,8 +283,8 @@ The above, converted to the current supported format:: linux-user mode CPUs -------------------- =20 -``ppc64abi32`` CPUs (since 5.2.0) -''''''''''''''''''''''''''''''''' +``ppc64abi32`` CPUs (since 5.2) +''''''''''''''''''''''''''''''' =20 The ``ppc64abi32`` architecture has a number of issues which regularly trip up our CI testing and is suspected to be quite broken. For that @@ -303,8 +303,8 @@ Related binaries Backwards compatibility ----------------------- =20 -Runnability guarantee of CPU models (since 4.1.0) -''''''''''''''''''''''''''''''''''''''''''''''''' +Runnability guarantee of CPU models (since 4.1) +''''''''''''''''''''''''''''''''''''''''''''''' =20 Previous versions of QEMU never changed existing CPU models in ways that introduced additional host software or hardware diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.= rst index 6a9c5bb484..1c926a8bc1 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -194,8 +194,8 @@ by the ``tls-authz`` and ``sasl-authz`` options. The ``pretty=3Don|off`` switch has no effect for HMP monitors and its use is rejected. =20 -``-drive file=3Djson:{...{'driver':'file'}}`` (removed 6.0) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``-drive file=3Djson:{...{'driver':'file'}}`` (removed in 6.0) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 The 'file' driver for drives is no longer appropriate for character or host devices and will only accept regular files (S_IFREG). The correct driver @@ -272,8 +272,8 @@ for the RISC-V ``virt`` machine and ``sifive_u`` machin= e. QEMU Machine Protocol (QMP) commands ------------------------------------ =20 -``block-dirty-bitmap-add`` "autoload" parameter (removed in 4.2.0) -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``block-dirty-bitmap-add`` "autoload" parameter (removed in 4.2) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 The "autoload" parameter has been ignored since 2.12.0. All bitmaps are automatically loaded from qcow2 images. @@ -456,15 +456,15 @@ Nobody was using this CPU emulation in QEMU, and ther= e were no test images available to make sure that the code is still working, so it has been remo= ved without replacement. =20 -``lm32`` CPUs (removed in 6.1.0) -'''''''''''''''''''''''''''''''' +``lm32`` CPUs (removed in 6.1) +'''''''''''''''''''''''''''''' =20 The only public user of this architecture was the milkymist project, which has been dead for years; there was never an upstream Linux port. Removed without replacement. =20 -``unicore32`` CPUs (since 6.1.0) -'''''''''''''''''''''''''''''''' +``unicore32`` CPUs (removed in 6.1) +''''''''''''''''''''''''''''''''''' =20 Support for this CPU was removed from the upstream Linux kernel, and there is no available upstream toolchain to build binaries for it. @@ -593,8 +593,8 @@ error when ``-u`` is not used. Command line options -------------------- =20 -``-smp`` (invalid topologies) (removed 5.2) -''''''''''''''''''''''''''''''''''''''''''' +``-smp`` (invalid topologies) (removed in 5.2) +'''''''''''''''''''''''''''''''''''''''''''''' =20 CPU topology properties should describe whole machine topology including possible CPUs. @@ -606,8 +606,8 @@ Support for invalid topologies is removed, the user mus= t ensure topologies described with -smp include all possible cpus, i.e. *sockets* * *cores* * *threads* =3D *maxcpus*. =20 -``-numa`` node (without memory specified) (removed 5.2) -''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``-numa`` node (without memory specified) (removed in 5.2) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 Splitting RAM by default between NUMA nodes had the same issues as ``mem`` parameter with the difference that the role of the user plays QEMU using @@ -647,8 +647,8 @@ as ignored. Currently, users are responsible for making= sure the backing storage specified with ``-mem-path`` can actually provide the guest RAM configured= with ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful. =20 -``-machine enforce-config-section=3Don|off`` (removed 5.2) -'''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``-machine enforce-config-section=3Don|off`` (removed in 5.2) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 The ``enforce-config-section`` property was replaced by the ``-global migration.send-configuration=3D{on|off}`` option. --=20 2.27.0 From nobody Fri May 3 02:04:46 2024 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=1629889496; cv=none; d=zohomail.com; s=zohoarc; b=PtjKcqtiL/NWcYxdSd2IRiN5spvshNI38HBpYPz+AaTHYvXjCFag3+zywDJeRmLe1Kco02QtVfpUPQRt27pUBTDL33Dz6PI3uEVtBqnh/yrKT3WkBy/KQvJju7Qo1aTl3MjaEUP4k44cpTZeS7Gtrx827mogwLfP2UqhxxKPewA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629889496; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=cwuBEI7wFDBxPMDfVnLw+Puvmf67IU4A6SAHula/ydA=; b=FRJlXdllqDd50IpqUrmn8wgqVTwQ2KVoDeByb44JBiQirf6RK67AYFXTK/BGr/AtqS8lUufAyZgXvMj9aaiPu0NRAnJJJXZSn+bpM9wy7AszXKqyXoO1LOOJv2+cfnftaouLTcChZduIMLKQA1QQ+FxdrfKtL4edJem4+hy2k48= 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 1629889496908235.9927881936802; Wed, 25 Aug 2021 04:04:56 -0700 (PDT) Received: from localhost ([::1]:39778 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIqiF-0006EB-KS for importer@patchew.org; Wed, 25 Aug 2021 07:04:55 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53644) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe4-0007wK-PZ for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:36 -0400 Received: from us-smtp-delivery-124.mimecast.com ([216.205.24.124]:43996) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe1-0004ke-NL for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:36 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-347-ccwO5qqxMNyeszqPGH6Stg-1; Wed, 25 Aug 2021 07:00:31 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 7777E190A7A2; Wed, 25 Aug 2021 11:00:30 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.111]) by smtp.corp.redhat.com (Postfix) with ESMTP id B67B05D741; Wed, 25 Aug 2021 11:00:29 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629889233; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=cwuBEI7wFDBxPMDfVnLw+Puvmf67IU4A6SAHula/ydA=; b=WSVsS0i+6Q5lkLa8+hN35lyLCcm2cI7F750V6wOYo0d8xD+eMmlmiALvgNZdeoN2bh5BNn 7pF28BSTIf1BQaV7LfHPQIcy4+7Lm5LLOgMvEoLjZXKvdMRqprqO1m1tfeACbqf+sFudd7 fUwXwszZUzpYw5mmQYh3ba981xER6bw= X-MC-Unique: ccwO5qqxMNyeszqPGH6Stg-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 3/6] docs/about: Add the missing release record in the subject Date: Wed, 25 Aug 2021 13:00:15 +0200 Message-Id: <20210825110018.100913-4-thuth@redhat.com> In-Reply-To: <20210825110018.100913-1-thuth@redhat.com> References: <20210825110018.100913-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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=216.205.24.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.745, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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.23 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" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629889498667100001 Content-Type: text/plain; charset="utf-8" From: Yanan Wang Commit 29e0447551 (docs/about/removed-features: Document removed CLI options from QEMU v3.1) has recorded some CLI options as replaced/removed from QEMU v3.1, but one of the subjects has missed the release record. Let's fix it. Reported-by: Cornelia Huck Signed-off-by: Yanan Wang Reviewed-by: Andrew Jones Reviewed-by: Thomas Huth Message-Id: <20210823030005.165668-4-wangyanan55@huawei.com> Signed-off-by: Thomas Huth --- docs/about/removed-features.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.= rst index 1c926a8bc1..8feeead449 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -140,8 +140,8 @@ Use ``-rtc driftfix=3Dslew`` instead. =20 Replaced by ``-rtc base=3Ddate``. =20 -``-vnc ...,tls=3D...``, ``-vnc ...,x509=3D...`` & ``-vnc ...,x509verify=3D= ...`` -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' +``-vnc ...,tls=3D...``, ``-vnc ...,x509=3D...`` & ``-vnc ...,x509verify=3D= ...`` (removed in 3.1) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''= '''''''''''''''' =20 The "tls-creds" option should be used instead to point to a "tls-creds-x50= 9" object created using "-object". --=20 2.27.0 From nobody Fri May 3 02:04:46 2024 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=1629889694; cv=none; d=zohomail.com; s=zohoarc; b=KgCNgxJJQIsKLr71Q/TFTUkcakM1XuaZVJyPf3tMnwOsDJHRzQVvYCyuHTu2eJLHhnTyggJjFcqDldfc6m3tRjkbrFWYnAPb2U/Ym6NTeef/6kaMob2tVGaCHeVcRm5BTcoYUY7UoPl9dFLxwlmTgBKWCcGohUf8othLJFquMrQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629889694; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=bzq6iZWC3RUvSniMXJvrslApm8yLzaYYlXZvBru7tvs=; b=Nb+USGobte/gsUHhQ9WIgTc0ACnjQugfi0n1QJ9vZW/gbEKJ61BUJqnszKyUmhXS7AzmaDi7kc+YItkJFg26byS9bO4i2dnC7OWX9NmhZPqHOt0gj9Th58NIxl3yyCGiRUJQGlV3ReVbu9PQ6Gcyav+VJcl+xw3evSSJaA9ioxU= 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 1629889694037284.22683114853703; Wed, 25 Aug 2021 04:08:14 -0700 (PDT) Received: from localhost ([::1]:46928 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIqlQ-0002tC-VQ for importer@patchew.org; Wed, 25 Aug 2021 07:08:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53658) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe5-0007yn-Kq for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:37 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:38619) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe3-0004lK-AF for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:37 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-560-vXYBPbcIPIWHp9IPdBD7Yg-1; Wed, 25 Aug 2021 07:00:32 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id BEE198799EB; Wed, 25 Aug 2021 11:00:31 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.111]) by smtp.corp.redhat.com (Postfix) with ESMTP id C84BA5D741; Wed, 25 Aug 2021 11:00:30 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629889234; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=bzq6iZWC3RUvSniMXJvrslApm8yLzaYYlXZvBru7tvs=; b=ddT0lEFMpY5XQDZpO7tMFwaHp+BTlJDkSJL2ZSPBiliaJDMeX5mhSk+n5Orj6hE00foUOv hu4oYpXWUpOS77vM/o+nAdNTXLneamoG4X+Q/8ic21b72IClHPEdM7apMrH+6sZfL1vmrZ 4cQug1mMPmrlpc5kJAN53VztsE54E40= X-MC-Unique: vXYBPbcIPIWHp9IPdBD7Yg-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 4/6] docs/about/removed-features: Move some CLI options to the right location Date: Wed, 25 Aug 2021 13:00:16 +0200 Message-Id: <20210825110018.100913-5-thuth@redhat.com> In-Reply-To: <20210825110018.100913-1-thuth@redhat.com> References: <20210825110018.100913-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: quoted-printable 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.133.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.745, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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.23 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" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629889695183100001 Content-Type: text/plain; charset="utf-8" Some of the removed CLI options have been added to the wrong section in the "Removed features" chapter - they've been put into the "Related binaries" section instead. Move them now into the correct "System emulator command line arguments" section. Message-Id: <20210818112908.102205-1-thuth@redhat.com> Signed-off-by: Thomas Huth --- docs/about/removed-features.rst | 124 ++++++++++++++++---------------- 1 file changed, 61 insertions(+), 63 deletions(-) diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.= rst index 8feeead449..08f9e625ce 100644 --- a/docs/about/removed-features.rst +++ b/docs/about/removed-features.rst @@ -146,12 +146,73 @@ Replaced by ``-rtc base=3Ddate``. The "tls-creds" option should be used instead to point to a "tls-creds-x50= 9" object created using "-object". =20 +``-mem-path`` fallback to RAM (removed in 5.0) +'''''''''''''''''''''''''''''''''''''''''''''' + +If guest RAM allocation from file pointed by ``mem-path`` failed, +QEMU was falling back to allocating from RAM, which might have resulted +in unpredictable behavior since the backing file specified by the user +as ignored. Currently, users are responsible for making sure the backing s= torage +specified with ``-mem-path`` can actually provide the guest RAM configured= with +``-m`` and QEMU fails to start up if RAM allocation is unsuccessful. + ``-net ...,name=3D...`` (removed in 5.1) '''''''''''''''''''''''''''''''''''''' =20 The ``name`` parameter of the ``-net`` option was a synonym for the ``id`` parameter, which should now be used instead. =20 +``-numa node,mem=3D...`` (removed in 5.1) +''''''''''''''''''''''''''''''''''''''' + +The parameter ``mem`` of ``-numa node`` was used to assign a part of guest= RAM +to a NUMA node. But when using it, it's impossible to manage a specified R= AM +chunk on the host side (like bind it to a host node, setting bind policy, = ...), +so the guest ends up with the fake NUMA configuration with suboptiomal +performance. +However since 2014 there is an alternative way to assign RAM to a NUMA node +using parameter ``memdev``, which does the same as ``mem`` and adds +means to actually manage node RAM on the host side. Use parameter ``memdev= `` +with *memory-backend-ram* backend as replacement for parameter ``mem`` +to achieve the same fake NUMA effect or a properly configured +*memory-backend-file* backend to actually benefit from NUMA configuration. +New machine versions (since 5.1) will not accept the option but it will st= ill +work with old machine types. User can check the QAPI schema to see if the = legacy +option is supported by looking at MachineInfo::numa-mem-supported property. + +``-numa`` node (without memory specified) (removed in 5.2) +'''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +Splitting RAM by default between NUMA nodes had the same issues as ``mem`` +parameter with the difference that the role of the user plays QEMU using +implicit generic or board specific splitting rule. +Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if +it's supported by used machine type) to define mapping explicitly instead. +Users of existing VMs, wishing to preserve the same RAM distribution, shou= ld +configure it explicitly using ``-numa node,memdev`` options. Current RAM +distribution can be retrieved using HMP command ``info numa`` and if separ= ate +memory devices (pc|nv-dimm) are present use ``info memory-device`` and sub= tract +device memory from output of ``info numa``. + +``-smp`` (invalid topologies) (removed in 5.2) +'''''''''''''''''''''''''''''''''''''''''''''' + +CPU topology properties should describe whole machine topology including +possible CPUs. + +However, historically it was possible to start QEMU with an incorrect topo= logy +where *n* <=3D *sockets* * *cores* * *threads* < *maxcpus*, +which could lead to an incorrect topology enumeration by the guest. +Support for invalid topologies is removed, the user must ensure +topologies described with -smp include all possible cpus, i.e. +*sockets* * *cores* * *threads* =3D *maxcpus*. + +``-machine enforce-config-section=3Don|off`` (removed in 5.2) +''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' + +The ``enforce-config-section`` property was replaced by the +``-global migration.send-configuration=3D{on|off}`` option. + ``-no-kvm`` (removed in 5.2) '''''''''''''''''''''''''''' =20 @@ -590,69 +651,6 @@ enforce that any failure to open the backing image (in= cluding if the backing file is missing or an incorrect format was specified) is an error when ``-u`` is not used. =20 -Command line options --------------------- - -``-smp`` (invalid topologies) (removed in 5.2) -'''''''''''''''''''''''''''''''''''''''''''''' - -CPU topology properties should describe whole machine topology including -possible CPUs. - -However, historically it was possible to start QEMU with an incorrect topo= logy -where *n* <=3D *sockets* * *cores* * *threads* < *maxcpus*, -which could lead to an incorrect topology enumeration by the guest. -Support for invalid topologies is removed, the user must ensure -topologies described with -smp include all possible cpus, i.e. -*sockets* * *cores* * *threads* =3D *maxcpus*. - -``-numa`` node (without memory specified) (removed in 5.2) -'''''''''''''''''''''''''''''''''''''''''''''''''''''''''' - -Splitting RAM by default between NUMA nodes had the same issues as ``mem`` -parameter with the difference that the role of the user plays QEMU using -implicit generic or board specific splitting rule. -Use ``memdev`` with *memory-backend-ram* backend or ``mem`` (if -it's supported by used machine type) to define mapping explicitly instead. -Users of existing VMs, wishing to preserve the same RAM distribution, shou= ld -configure it explicitly using ``-numa node,memdev`` options. Current RAM -distribution can be retrieved using HMP command ``info numa`` and if separ= ate -memory devices (pc|nv-dimm) are present use ``info memory-device`` and sub= tract -device memory from output of ``info numa``. - -``-numa node,mem=3D``\ *size* (removed in 5.1) -'''''''''''''''''''''''''''''''''''''''''''' - -The parameter ``mem`` of ``-numa node`` was used to assign a part of -guest RAM to a NUMA node. But when using it, it's impossible to manage a s= pecified -RAM chunk on the host side (like bind it to a host node, setting bind poli= cy, ...), -so the guest ends up with the fake NUMA configuration with suboptiomal per= formance. -However since 2014 there is an alternative way to assign RAM to a NUMA node -using parameter ``memdev``, which does the same as ``mem`` and adds -means to actually manage node RAM on the host side. Use parameter ``memdev= `` -with *memory-backend-ram* backend as replacement for parameter ``mem`` -to achieve the same fake NUMA effect or a properly configured -*memory-backend-file* backend to actually benefit from NUMA configuration. -New machine versions (since 5.1) will not accept the option but it will st= ill -work with old machine types. User can check the QAPI schema to see if the = legacy -option is supported by looking at MachineInfo::numa-mem-supported property. - -``-mem-path`` fallback to RAM (removed in 5.0) -'''''''''''''''''''''''''''''''''''''''''''''' - -If guest RAM allocation from file pointed by ``mem-path`` failed, -QEMU was falling back to allocating from RAM, which might have resulted -in unpredictable behavior since the backing file specified by the user -as ignored. Currently, users are responsible for making sure the backing s= torage -specified with ``-mem-path`` can actually provide the guest RAM configured= with -``-m`` and QEMU fails to start up if RAM allocation is unsuccessful. - -``-machine enforce-config-section=3Don|off`` (removed in 5.2) -''''''''''''''''''''''''''''''''''''''''''''''''''''''''''' - -The ``enforce-config-section`` property was replaced by the -``-global migration.send-configuration=3D{on|off}`` option. - qemu-img amend to adjust backing file (removed in 6.1) '''''''''''''''''''''''''''''''''''''''''''''''''''''' =20 --=20 2.27.0 From nobody Fri May 3 02:04:46 2024 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=1629890328; cv=none; d=zohomail.com; s=zohoarc; b=YgSt3VT9fsqJzKpQjlxoCk2Cv/8S1a79CVn3Dv+yU10mWNb76AJxpZicXMjNrT9LVx45AJceqWW5CGEqZS2Yxe9JRiM7qCP5WPuw6Kuo1gabwSVo0sr0jsQ+uddYOB8ZCjrvAyhx16fGwBkgbHlZbcDPC15chSZ0WHTeITJteVM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629890328; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=mA6Bb2DgoS/I7vO7dM96F8LqnVaIRZLaCsFm4v9DyWs=; b=Z6ujLjgIFQiS1BFEy/+r/xZsSW9Nh/MpYQsunwRDbtiRbcySeZjd/wU0h0jIXud87HUOxxQwvnwfGhuBfGh0Ft6GA3fQD8hpNc9HmTIS9ZfN1kH1QwntFUG37M5YgCaFLcuwaapkdxgDq5LNHwARn/JTILHaM0VexQYaQCSuWEA= 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 1629890328975393.19341729483347; Wed, 25 Aug 2021 04:18:48 -0700 (PDT) Received: from localhost ([::1]:45070 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIqvf-0004nE-Tn for importer@patchew.org; Wed, 25 Aug 2021 07:18:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53714) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqeB-0008CM-UR for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:43 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]:25536) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe6-0004nx-TB for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:43 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-15-LoSYlKAiMaetCjgkX6zNOw-1; Wed, 25 Aug 2021 07:00:34 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 28C12190A7A4; Wed, 25 Aug 2021 11:00:33 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.111]) by smtp.corp.redhat.com (Postfix) with ESMTP id 322915D741; Wed, 25 Aug 2021 11:00:32 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629889238; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=mA6Bb2DgoS/I7vO7dM96F8LqnVaIRZLaCsFm4v9DyWs=; b=hDR1qejhlDUDTVhyQdlVcbfDCVPF9JwsVQELwY47kvBmre3B2PIzBXHJgVA0V/FN/hvw+k /ESefBkOnyvgg8Wo19Vxr+MYwUTeAalxxvsAFfn01HsrBrLxPZUqMSNJqqTEKseiAXBEhi uIinPcdIBbk/AiEMLuwtml/xjj2tp7g= X-MC-Unique: LoSYlKAiMaetCjgkX6zNOw-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 5/6] docs: split the CI docs into two files Date: Wed, 25 Aug 2021 13:00:17 +0200 Message-Id: <20210825110018.100913-6-thuth@redhat.com> In-Reply-To: <20210825110018.100913-1-thuth@redhat.com> References: <20210825110018.100913-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.745, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, 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.23 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" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629890330529100001 From: Daniel P. Berrang=C3=A9 This splits the CI docs into one file talking about job setup and usage and another file describing provisioning of custom runners. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Willian Rampazzo Message-Id: <20210812180403.4129067-2-berrange@redhat.com> Signed-off-by: Thomas Huth --- docs/devel/ci-jobs.rst | 40 ++++++++++ docs/devel/ci-runners.rst | 117 ++++++++++++++++++++++++++++ docs/devel/ci.rst | 159 +------------------------------------- 3 files changed, 159 insertions(+), 157 deletions(-) create mode 100644 docs/devel/ci-jobs.rst create mode 100644 docs/devel/ci-runners.rst diff --git a/docs/devel/ci-jobs.rst b/docs/devel/ci-jobs.rst new file mode 100644 index 0000000000..9cd9819786 --- /dev/null +++ b/docs/devel/ci-jobs.rst @@ -0,0 +1,40 @@ +Custom CI/CD variables +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +QEMU CI pipelines can be tuned by setting some CI environment variables. + +Set variable globally in the user's CI namespace +------------------------------------------------ + +Variables can be set globally in the user's CI namespace setting. + +For further information about how to set these variables, please refer to:: + + https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project + +Set variable manually when pushing a branch or tag to the user's repository +--------------------------------------------------------------------------- + +Variables can be set manually when pushing a branch or tag, using +git-push command line arguments. + +Example setting the QEMU_CI_EXAMPLE_VAR variable: + +.. code:: + + git push -o ci.variable=3D"QEMU_CI_EXAMPLE_VAR=3Dvalue" myrepo mybranch + +For further information about how to set these variables, please refer to:: + + https://docs.gitlab.com/ee/user/project/push_options.html#push-options-f= or-gitlab-cicd + +Here is a list of the most used variables: + +QEMU_CI_AVOCADO_TESTING +~~~~~~~~~~~~~~~~~~~~~~~ +By default, tests using the Avocado framework are not run automatically in +the pipelines (because multiple artifacts have to be downloaded, and if +these artifacts are not already cached, downloading them make the jobs +reach the timeout limit). Set this variable to have the tests using the +Avocado framework run automatically. + diff --git a/docs/devel/ci-runners.rst b/docs/devel/ci-runners.rst new file mode 100644 index 0000000000..7817001fb2 --- /dev/null +++ b/docs/devel/ci-runners.rst @@ -0,0 +1,117 @@ +Jobs on Custom Runners +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D + +Besides the jobs run under the various CI systems listed before, there +are a number additional jobs that will run before an actual merge. +These use the same GitLab CI's service/framework already used for all +other GitLab based CI jobs, but rely on additional systems, not the +ones provided by GitLab as "shared runners". + +The architecture of GitLab's CI service allows different machines to +be set up with GitLab's "agent", called gitlab-runner, which will take +care of running jobs created by events such as a push to a branch. +Here, the combination of a machine, properly configured with GitLab's +gitlab-runner, is called a "custom runner". + +The GitLab CI jobs definition for the custom runners are located under:: + + .gitlab-ci.d/custom-runners.yml + +Custom runners entail custom machines. To see a list of the machines +currently deployed in the QEMU GitLab CI and their maintainers, please +refer to the QEMU `wiki `__. + +Machine Setup Howto +------------------- + +For all Linux based systems, the setup can be mostly automated by the +execution of two Ansible playbooks. Create an ``inventory`` file +under ``scripts/ci/setup``, such as this:: + + fully.qualified.domain + other.machine.hostname + +You may need to set some variables in the inventory file itself. One +very common need is to tell Ansible to use a Python 3 interpreter on +those hosts. This would look like:: + + fully.qualified.domain ansible_python_interpreter=3D/usr/bin/python3 + other.machine.hostname ansible_python_interpreter=3D/usr/bin/python3 + +Build environment +~~~~~~~~~~~~~~~~~ + +The ``scripts/ci/setup/build-environment.yml`` Ansible playbook will +set up machines with the environment needed to perform builds and run +QEMU tests. This playbook consists on the installation of various +required packages (and a general package update while at it). It +currently covers a number of different Linux distributions, but it can +be expanded to cover other systems. + +The minimum required version of Ansible successfully tested in this +playbook is 2.8.0 (a version check is embedded within the playbook +itself). To run the playbook, execute:: + + cd scripts/ci/setup + ansible-playbook -i inventory build-environment.yml + +Please note that most of the tasks in the playbook require superuser +privileges, such as those from the ``root`` account or those obtained +by ``sudo``. If necessary, please refer to ``ansible-playbook`` +options such as ``--become``, ``--become-method``, ``--become-user`` +and ``--ask-become-pass``. + +gitlab-runner setup and registration +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The gitlab-runner agent needs to be installed on each machine that +will run jobs. The association between a machine and a GitLab project +happens with a registration token. To find the registration token for +your repository/project, navigate on GitLab's web UI to: + + * Settings (the gears-like icon at the bottom of the left hand side + vertical toolbar), then + * CI/CD, then + * Runners, and click on the "Expand" button, then + * Under "Set up a specific Runner manually", look for the value under + "And this registration token:" + +Copy the ``scripts/ci/setup/vars.yml.template`` file to +``scripts/ci/setup/vars.yml``. Then, set the +``gitlab_runner_registration_token`` variable to the value obtained +earlier. + +To run the playbook, execute:: + + cd scripts/ci/setup + ansible-playbook -i inventory gitlab-runner.yml + +Following the registration, it's necessary to configure the runner tags, +and optionally other configurations on the GitLab UI. Navigate to: + + * Settings (the gears like icon), then + * CI/CD, then + * Runners, and click on the "Expand" button, then + * "Runners activated for this project", then + * Click on the "Edit" icon (next to the "Lock" Icon) + +Tags are very important as they are used to route specific jobs to +specific types of runners, so it's a good idea to double check that +the automatically created tags are consistent with the OS and +architecture. For instance, an Ubuntu 20.04 aarch64 system should +have tags set as:: + + ubuntu_20.04,aarch64 + +Because the job definition at ``.gitlab-ci.d/custom-runners.yml`` +would contain:: + + ubuntu-20.04-aarch64-all: + tags: + - ubuntu_20.04 + - aarch64 + +It's also recommended to: + + * increase the "Maximum job timeout" to something like ``2h`` + * give it a better Description diff --git a/docs/devel/ci.rst b/docs/devel/ci.rst index 205572510c..a6a650968b 100644 --- a/docs/devel/ci.rst +++ b/docs/devel/ci.rst @@ -8,160 +8,5 @@ found at:: =20 https://wiki.qemu.org/Testing/CI =20 -Custom CI/CD variables -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -QEMU CI pipelines can be tuned by setting some CI environment variables. - -Set variable globally in the user's CI namespace ------------------------------------------------- - -Variables can be set globally in the user's CI namespace setting. - -For further information about how to set these variables, please refer to:: - - https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project - -Set variable manually when pushing a branch or tag to the user's repository ---------------------------------------------------------------------------- - -Variables can be set manually when pushing a branch or tag, using -git-push command line arguments. - -Example setting the QEMU_CI_EXAMPLE_VAR variable: - -.. code:: - - git push -o ci.variable=3D"QEMU_CI_EXAMPLE_VAR=3Dvalue" myrepo mybranch - -For further information about how to set these variables, please refer to:: - - https://docs.gitlab.com/ee/user/project/push_options.html#push-options-f= or-gitlab-cicd - -Here is a list of the most used variables: - -QEMU_CI_AVOCADO_TESTING -~~~~~~~~~~~~~~~~~~~~~~~ -By default, tests using the Avocado framework are not run automatically in -the pipelines (because multiple artifacts have to be downloaded, and if -these artifacts are not already cached, downloading them make the jobs -reach the timeout limit). Set this variable to have the tests using the -Avocado framework run automatically. - -Jobs on Custom Runners -=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D - -Besides the jobs run under the various CI systems listed before, there -are a number additional jobs that will run before an actual merge. -These use the same GitLab CI's service/framework already used for all -other GitLab based CI jobs, but rely on additional systems, not the -ones provided by GitLab as "shared runners". - -The architecture of GitLab's CI service allows different machines to -be set up with GitLab's "agent", called gitlab-runner, which will take -care of running jobs created by events such as a push to a branch. -Here, the combination of a machine, properly configured with GitLab's -gitlab-runner, is called a "custom runner". - -The GitLab CI jobs definition for the custom runners are located under:: - - .gitlab-ci.d/custom-runners.yml - -Custom runners entail custom machines. To see a list of the machines -currently deployed in the QEMU GitLab CI and their maintainers, please -refer to the QEMU `wiki `__. - -Machine Setup Howto -------------------- - -For all Linux based systems, the setup can be mostly automated by the -execution of two Ansible playbooks. Create an ``inventory`` file -under ``scripts/ci/setup``, such as this:: - - fully.qualified.domain - other.machine.hostname - -You may need to set some variables in the inventory file itself. One -very common need is to tell Ansible to use a Python 3 interpreter on -those hosts. This would look like:: - - fully.qualified.domain ansible_python_interpreter=3D/usr/bin/python3 - other.machine.hostname ansible_python_interpreter=3D/usr/bin/python3 - -Build environment -~~~~~~~~~~~~~~~~~ - -The ``scripts/ci/setup/build-environment.yml`` Ansible playbook will -set up machines with the environment needed to perform builds and run -QEMU tests. This playbook consists on the installation of various -required packages (and a general package update while at it). It -currently covers a number of different Linux distributions, but it can -be expanded to cover other systems. - -The minimum required version of Ansible successfully tested in this -playbook is 2.8.0 (a version check is embedded within the playbook -itself). To run the playbook, execute:: - - cd scripts/ci/setup - ansible-playbook -i inventory build-environment.yml - -Please note that most of the tasks in the playbook require superuser -privileges, such as those from the ``root`` account or those obtained -by ``sudo``. If necessary, please refer to ``ansible-playbook`` -options such as ``--become``, ``--become-method``, ``--become-user`` -and ``--ask-become-pass``. - -gitlab-runner setup and registration -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -The gitlab-runner agent needs to be installed on each machine that -will run jobs. The association between a machine and a GitLab project -happens with a registration token. To find the registration token for -your repository/project, navigate on GitLab's web UI to: - - * Settings (the gears-like icon at the bottom of the left hand side - vertical toolbar), then - * CI/CD, then - * Runners, and click on the "Expand" button, then - * Under "Set up a specific Runner manually", look for the value under - "And this registration token:" - -Copy the ``scripts/ci/setup/vars.yml.template`` file to -``scripts/ci/setup/vars.yml``. Then, set the -``gitlab_runner_registration_token`` variable to the value obtained -earlier. - -To run the playbook, execute:: - - cd scripts/ci/setup - ansible-playbook -i inventory gitlab-runner.yml - -Following the registration, it's necessary to configure the runner tags, -and optionally other configurations on the GitLab UI. Navigate to: - - * Settings (the gears like icon), then - * CI/CD, then - * Runners, and click on the "Expand" button, then - * "Runners activated for this project", then - * Click on the "Edit" icon (next to the "Lock" Icon) - -Tags are very important as they are used to route specific jobs to -specific types of runners, so it's a good idea to double check that -the automatically created tags are consistent with the OS and -architecture. For instance, an Ubuntu 20.04 aarch64 system should -have tags set as:: - - ubuntu_20.04,aarch64 - -Because the job definition at ``.gitlab-ci.d/custom-runners.yml`` -would contain:: - - ubuntu-20.04-aarch64-all: - tags: - - ubuntu_20.04 - - aarch64 - -It's also recommended to: - - * increase the "Maximum job timeout" to something like ``2h`` - * give it a better Description +.. include:: ci-jobs.rst +.. include:: ci-runners.rst --=20 2.27.0 From nobody Fri May 3 02:04:46 2024 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=1629890163; cv=none; d=zohomail.com; s=zohoarc; b=CXSS8H5mtAQCYlslZIhnhAzI9yH7Wu43OBliPf2NNiLwBS28mN6/OzLX6r372jajJ96IsrYELk73ZqYKcjQJQM8gBIqfd8rBnn2vIiuBMoe5U8WyEvXvSco8p9BIajSRDCToMZqn9Hvs6OqINA0Gx1lGSIJmXe/o7FIrRN/J4lc= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1629890163; h=Content-Type:Content-Transfer-Encoding:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=2cfB9gQJlzr6Y8BBFHCi3rrszaBm4+gUEwiUAtKzT84=; b=nOaUVJ03aJF644j+KVMh0UmwjIQajxZfzBdyi9L21nQpeZEDroTppVTGATzDJaYzpYMD96EIFG4ZxsJ9pK2TeYWBCpO2nt4v4BYZprJ2oKARDP04JvLUzXbLBLVE4VBxADV1h9CdtETTSIoBSQ2eKC/VfwJtqeBeywrJqsKKI2A= 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 1629890163615819.6987762576385; Wed, 25 Aug 2021 04:16:03 -0700 (PDT) Received: from localhost ([::1]:39942 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1mIqt0-00013B-LH for importer@patchew.org; Wed, 25 Aug 2021 07:16:02 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:53692) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe8-00085y-A3 for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:40 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:37629) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1mIqe6-0004nI-Gi for qemu-devel@nongnu.org; Wed, 25 Aug 2021 07:00:39 -0400 Received: from mimecast-mx01.redhat.com (mimecast-mx01.redhat.com [209.132.183.4]) (Using TLS) by relay.mimecast.com with ESMTP id us-mta-498-niayuVIkPh-8kp4sXrozhA-1; Wed, 25 Aug 2021 07:00:35 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.phx2.redhat.com [10.5.11.15]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx01.redhat.com (Postfix) with ESMTPS id 55F8180124F; Wed, 25 Aug 2021 11:00:34 +0000 (UTC) Received: from thuth.com (unknown [10.39.192.111]) by smtp.corp.redhat.com (Postfix) with ESMTP id 83E1F3AC1; Wed, 25 Aug 2021 11:00:33 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1629889237; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2cfB9gQJlzr6Y8BBFHCi3rrszaBm4+gUEwiUAtKzT84=; b=KlcyALhxILQ1tEUl2YmtkFmAH63njb1hcbIqcCg60sOMFJrdeWZvEJJCcRS36BvmkvFggM pRRzXp9cDcT0h0YQ1Hk8EhTrTaNGUF9l1H2lpDy1uzVaG3qBmTqyNW7VSohSvTr7mveYsH M7xlkFTWR0v5wZAtYdPoWk8iyIvY33g= X-MC-Unique: niayuVIkPh-8kp4sXrozhA-1 From: Thomas Huth To: qemu-devel@nongnu.org, Peter Maydell Subject: [PULL 6/6] docs: make sphinx-build be quiet by default Date: Wed, 25 Aug 2021 13:00:18 +0200 Message-Id: <20210825110018.100913-7-thuth@redhat.com> In-Reply-To: <20210825110018.100913-1-thuth@redhat.com> References: <20210825110018.100913-1-thuth@redhat.com> MIME-Version: 1.0 X-Scanned-By: MIMEDefang 2.79 on 10.5.11.15 Authentication-Results: relay.mimecast.com; auth=pass smtp.auth=CUSA124A263 smtp.mailfrom=thuth@redhat.com X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable 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.133.124; envelope-from=thuth@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -34 X-Spam_score: -3.5 X-Spam_bar: --- X-Spam_report: (-3.5 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.745, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, RCVD_IN_MSPIKE_H2=-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.23 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" X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1629890165533100001 From: Daniel P. Berrang=C3=A9 The sphinx-build is fairly verbose spitting out pages of output to the console, which causes errors from other build commands to be scrolled off the top of the terminal. This can leave the mistaken impression that the build passed, when in fact there was a failure. Signed-off-by: Daniel P. Berrang=C3=A9 Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Marc-Andr=C3=A9 Lureau Message-Id: <20210812102427.4036399-1-berrange@redhat.com> Signed-off-by: Thomas Huth --- docs/meson.build | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/meson.build b/docs/meson.build index 300b134329..cffe1ecf1d 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -9,7 +9,7 @@ endif # Check if tools are available to build documentation. build_docs =3D false if sphinx_build.found() - SPHINX_ARGS =3D ['env', 'CONFDIR=3D' + qemu_confdir, sphinx_build] + SPHINX_ARGS =3D ['env', 'CONFDIR=3D' + qemu_confdir, sphinx_build, '-q'] # If we're making warnings fatal, apply this to Sphinx runs as well if get_option('werror') SPHINX_ARGS +=3D [ '-W' ] --=20 2.27.0