From: Andrew Jones <drjones@redhat.com>
Date: Tue, 17 Aug 2021 12:53:56 +0000 (+0200)
Subject: qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
X-Git-Tag: qemu-xen-4.16.0-rc4~5
X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=0572edc55b7bb862efadc2f061e4d9abb87171cc;p=qemu-xen.git

qapi/machine.json: Remove zero value reference from SMPConfiguration documentation

Commit 1e63fe685804 ("machine: pass QAPI struct to mc->smp_parse")
introduced documentation stating that a zero input value for an SMP
parameter indicates that its value should be automatically configured.
This is indeed how things work today, but we'd like to change that.
Avoid documenting behaviors we want to leave undefined for the time
being, giving us freedom to change it later.

Fixes: 1e63fe685804 ("machine: pass QAPI struct to mc->smp_parse")
Signed-off-by: Andrew Jones <drjones@redhat.com>
Acked-by: Paolo Bonzini <pbonzini@redhat.com>
Reviewed-by: Cornelia Huck <cohuck@redhat.com>
Reviewed-by: Yanan Wang <wangyanan55@huawei.com>
Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---

diff --git a/qapi/machine.json b/qapi/machine.json
index c3210ee1fb..157712f006 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1288,7 +1288,7 @@
 ##
 # @SMPConfiguration:
 #
-# Schema for CPU topology configuration.  "0" or a missing value lets
+# Schema for CPU topology configuration.  A missing value lets
 # QEMU figure out a suitable value based on the ones that are provided.
 #
 # @cpus: number of virtual CPUs in the virtual machine