1. Patchew
  2. QEMU
  3. View series

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

Andrew Jones posted 1 patch 2 years, 8 months ago
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20210817125356.9461-1-drjones@redhat.com
Maintainers: Markus Armbruster <armbru@redhat.com>, Eduardo Habkost <ehabkost@redhat.com>, Eric Blake <eblake@redhat.com>, Marcel Apfelbaum <marcel.apfelbaum@gmail.com>
qapi/machine.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
Posted by Andrew Jones 2 years, 8 months ago 
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>
---
 qapi/machine.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/machine.json b/qapi/machine.json
index c3210ee1fb24..157712f00614 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
-- 
2.31.1
Re: [PATCH] qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
Posted by wangyanan (Y) 2 years, 8 months ago 
On 2021/8/17 20:53, Andrew Jones wrote:
> 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>
> ---
>   qapi/machine.json | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/qapi/machine.json b/qapi/machine.json
> index c3210ee1fb24..157712f00614 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
Reviewed-by: Yanan Wang <wangyanan55@huawei.com>
.
Re: [PATCH] qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
Posted by Paolo Bonzini 2 years, 8 months ago 
On 17/08/21 14:53, Andrew Jones wrote:
> 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>
> ---
>   qapi/machine.json | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/qapi/machine.json b/qapi/machine.json
> index c3210ee1fb24..157712f00614 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
> 

Acked-by: Paolo Bonzini <pbonzini@redhat.com>
Re: [PATCH] qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
Posted by Cornelia Huck 2 years, 8 months ago 
On Tue, Aug 17 2021, Andrew Jones <drjones@redhat.com> wrote:

> 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>
> ---
>  qapi/machine.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Cornelia Huck <cohuck@redhat.com>
Re: [PATCH] qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
Posted by Philippe Mathieu-Daudé 2 years, 8 months ago 
On 8/17/21 2:53 PM, Andrew Jones wrote:
> 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>
> ---
>  qapi/machine.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/qapi/machine.json b/qapi/machine.json
> index c3210ee1fb24..157712f00614 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
> 

Reviewed-by: Philippe Mathieu-Daudé <philmd@redhat.com>
Re: [PATCH] qapi/machine.json: Remove zero value reference from SMPConfiguration documentation
Posted by Peter Maydell 2 years, 8 months ago 
On Tue, 17 Aug 2021 at 13:56, Andrew Jones <drjones@redhat.com> wrote:
>
> 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>
> ---
>  qapi/machine.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)


Applied, thanks.

Please update the changelog at https://wiki.qemu.org/ChangeLog/6.1
for any user-visible changes.

-- PMM

Patchew 2.1-devel-0870f84

© 2016 - 2024 Red Hat, Inc.