Skip to contentSkip to conversation

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

PATCH Applied Andrew Jones 6 participants 6 messages Aug 17, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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")
---
 qapi/machine.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
qapi/machine.json +1 -1
index c3210ee1fb24..157712f00614 100644
@@ -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
Signature · 1 line
2.31.1
Reviewed-by on v1 1/1
#1 lore raw
Quoted 18 lines · Andrew Jones

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")
---
  qapi/machine.json | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
qapi/machine.json +0 -0
index c3210ee1fb24..157712f00614 100644

qapi/machine.json line 1294

Quoted 8 lines
qapi/machine.json +1 -1
@@ -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 on v1 1/1
#2 lore raw
In reply to Andrew Jones
Quoted 19 lines · Andrew Jones

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")
---
  qapi/machine.json | 2 +-
  1 file changed, 1 insertion(+), 1 deletion(-)
qapi/machine.json +0 -0
index c3210ee1fb24..157712f00614 100644

qapi/machine.json line 1294

Quoted 8 lines
qapi/machine.json +1 -1
@@ -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 on v1 1/1
#3 lore raw
In reply to Andrew Jones
Quoted 7 lines · Andrew Jones

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.

Quoted 5 lines
Fixes 1e63fe685804 ("machine: pass QAPI struct to mc->smp_parse")
---
 qapi/machine.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
Reviewed-by on v1 1/1
#4 lore raw
In reply to Andrew Jones
Quoted 19 lines · Andrew Jones

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")
---
 qapi/machine.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
qapi/machine.json +0 -0
index c3210ee1fb24..157712f00614 100644

qapi/machine.json line 1294

Quoted 8 lines
qapi/machine.json +1 -1
@@ -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
#5 lore raw
In reply to Andrew Jones
Quoted 8 lines · Andrew Jones

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.

Quoted 5 lines
Fixes 1e63fe685804 ("machine: pass QAPI struct to mc->smp_parse")
---
 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