From: John Snow <js...@redhat.com>
Signed-off-by: John Snow <js...@redhat.com>
Message-ID: <20250711054005.60969-8-js...@redhat.com>
Reviewed-by: Markus Armbruster <arm...@redhat.com>
Signed-off-by: Markus Armbruster <arm...@redhat.com>
---
qapi/machine-common.json | 20 +++++-----
qapi/machine.json | 80 ++++++++++++++++++++--------------------
2 files changed, 50 insertions(+), 50 deletions(-)
diff --git a/qapi/machine-common.json b/qapi/machine-common.json
index 0f01599130..ed3d20a2fb 100644
--- a/qapi/machine-common.json
+++ b/qapi/machine-common.json
@@ -28,29 +28,29 @@
#
# @thread: thread level, which would also be called SMT level or
# logical processor level. The @threads option in
-# SMPConfiguration is used to configure the topology of this
+# `SMPConfiguration` is used to configure the topology of this
# level.
#
-# @core: core level. The @cores option in SMPConfiguration is used
+# @core: core level. The @cores option in `SMPConfiguration` is used
# to configure the topology of this level.
#
-# @module: module level. The @modules option in SMPConfiguration is
+# @module: module level. The @modules option in `SMPConfiguration` is
# used to configure the topology of this level.
#
-# @cluster: cluster level. The @clusters option in SMPConfiguration
+# @cluster: cluster level. The @clusters option in `SMPConfiguration`
# is used to configure the topology of this level.
#
-# @die: die level. The @dies option in SMPConfiguration is used to
+# @die: die level. The @dies option in `SMPConfiguration` is used to
# configure the topology of this level.
#
# @socket: socket level, which would also be called package level.
-# The @sockets option in SMPConfiguration is used to configure
+# The @sockets option in `SMPConfiguration` is used to configure
# the topology of this level.
#
-# @book: book level. The @books option in SMPConfiguration is used
+# @book: book level. The @books option in `SMPConfiguration` is used
# to configure the topology of this level.
#
-# @drawer: drawer level. The @drawers option in SMPConfiguration is
+# @drawer: drawer level. The @drawers option in `SMPConfiguration` is
# used to configure the topology of this level.
#
# @default: default level. Some architectures will have default
@@ -104,9 +104,9 @@
##
# @SmpCachePropertiesWrapper:
#
-# List wrapper of SmpCacheProperties.
+# List wrapper of `SmpCacheProperties`.
#
-# @caches: the list of SmpCacheProperties.
+# @caches: the list of `SmpCacheProperties`.
#
# Since 9.2
##
diff --git a/qapi/machine.json b/qapi/machine.json
index 2364893cba..f9bfda2151 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -188,7 +188,7 @@
# @acpi: machine type supports ACPI (since 8.0)
#
# @compat-props: The machine type's compatibility properties. Only
-# present when query-machines argument @compat-props is true.
+# present when `query-machines` argument @compat-props is true.
# (since 9.1)
#
# Features:
@@ -377,7 +377,7 @@
#
# Wake up guest from suspend. If the guest has wake-up from suspend
# support enabled (wakeup-suspend-support flag from
-# query-current-machine), wake-up guest from suspend if the guest is
+# `query-current-machine`), wake-up guest from suspend if the guest is
# in SUSPENDED state. Return an error otherwise.
#
# Since: 1.1
@@ -589,7 +589,7 @@
#
# List of CXL Fixed Memory Windows.
#
-# @cxl-fmw: List of CXLFixedMemoryWindowOptions
+# @cxl-fmw: List of `CXLFixedMemoryWindowOptions`
#
# Since: 7.1
##
@@ -644,10 +644,10 @@
##
# @NumaCpuOptions:
#
-# Option "-numa cpu" overrides default cpu to node mapping. It
-# accepts the same set of cpu properties as returned by
-# query-hotpluggable-cpus[].props, where node-id could be used to
-# override default node mapping.
+# Option "-numa cpu" overrides default cpu to node mapping. It accepts
+# the same set of cpu properties as returned by
+# `query-hotpluggable-cpus[].props <query-hotpluggable-cpus>`, where
+# node-id could be used to override default node mapping.
#
# Since: 2.10
##
@@ -661,7 +661,7 @@
# The memory hierarchy in the System Locality Latency and Bandwidth
# Information Structure of HMAT (Heterogeneous Memory Attribute Table)
#
-# For more information about @HmatLBMemoryHierarchy, see chapter
+# For more information about `HmatLBMemoryHierarchy`, see chapter
# 5.2.27.4: Table 5-146: Field "Flags" of ACPI 6.3 spec.
#
# @memory: the structure represents the memory performance
@@ -683,7 +683,7 @@
# Data type in the System Locality Latency and Bandwidth Information
# Structure of HMAT (Heterogeneous Memory Attribute Table)
#
-# For more information about @HmatLBDataType, see chapter 5.2.27.4:
+# For more information about `HmatLBDataType`, see chapter 5.2.27.4:
# Table 5-146: Field "Data Type" of ACPI 6.3 spec.
#
# @access-latency: access latency (nanoseconds)
@@ -710,7 +710,7 @@
# Set the system locality latency and bandwidth information between
# Initiator and Target proximity Domains.
#
-# For more information about @NumaHmatLBOptions, see chapter 5.2.27.4:
+# For more information about `NumaHmatLBOptions`, see chapter 5.2.27.4:
# Table 5-146 of ACPI 6.3 spec.
#
# @initiator: the Initiator Proximity Domain.
@@ -746,7 +746,7 @@
# Cache associativity in the Memory Side Cache Information Structure
# of HMAT
#
-# For more information of @HmatCacheAssociativity, see chapter
+# For more information of `HmatCacheAssociativity`, see chapter
# 5.2.27.5: Table 5-147 of ACPI 6.3 spec.
#
# @none: None (no memory side cache in this proximity domain, or cache
@@ -767,7 +767,7 @@
# Cache write policy in the Memory Side Cache Information Structure of
# HMAT
#
-# For more information of @HmatCacheWritePolicy, see chapter 5.2.27.5:
+# For more information of `HmatCacheWritePolicy`, see chapter 5.2.27.5:
# Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
#
# @none: None (no memory side cache in this proximity domain, or cache
@@ -787,7 +787,7 @@
#
# Set the memory side cache information for a given memory domain.
#
-# For more information of @NumaHmatCacheOptions, see chapter 5.2.27.5:
+# For more information of `NumaHmatCacheOptions`, see chapter 5.2.27.5:
# Table 5-147: Field "Cache Attributes" of ACPI 6.3 spec.
#
# @node-id: the memory proximity domain to which the memory belongs.
@@ -964,7 +964,7 @@
#
# The ids other than the node-id specify the position of the CPU
# within the CPU topology (as defined by the machine property "smp",
-# thus see also type @SMPConfiguration)
+# thus see also type `SMPConfiguration`)
#
# @node-id: NUMA node ID the CPU belongs to
#
@@ -992,7 +992,7 @@
# Since: 2.7
##
{ 'struct': 'CpuInstanceProperties',
- # Keep these in sync with the properties device_add accepts
+ # Keep these in sync with the properties `device_add` accepts
'data': { '*node-id': 'int',
'*drawer-id': 'int',
'*book-id': 'int',
@@ -1008,19 +1008,19 @@
##
# @HotpluggableCPU:
#
-# @type: CPU object type for usage with device_add command
+# @type: CPU object type for usage with `device_add` command
#
# @props: list of properties to pass for hotplugging a CPU with
-# device_add
+# `device_add`
#
-# @vcpus-count: number of logical VCPU threads @HotpluggableCPU
+# @vcpus-count: number of logical VCPU threads `HotpluggableCPU`
# provides
#
# @qom-path: link to existing CPU object if CPU is present or omitted
# if CPU is not present.
#
# .. note:: Management should be prepared to pass through additional
-# properties with device_add.
+# properties with `device_add`.
#
# Since: 2.7
##
@@ -1179,7 +1179,7 @@
# @BALLOON_CHANGE:
#
# Emitted when the guest changes the actual BALLOON level. This value
-# is equivalent to the @actual field return by the 'query-balloon'
+# is equivalent to the @actual field return by the `query-balloon`
# command
#
# @actual: the logical size of the VM in bytes. Formula used:
@@ -1965,7 +1965,7 @@
#
# The result of a CPU model baseline.
#
-# @model: the baselined CpuModelInfo.
+# @model: the baselined `CpuModelInfo`.
#
# Since: 2.8
##
@@ -2014,28 +2014,28 @@
#
# * QEMU version: CPU models may look different depending on the QEMU
# version. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * machine-type: CPU model may look different depending on the
# machine-type. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * machine options (including accelerator): in some architectures,
# CPU models may look different depending on machine and accelerator
# options. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * "-cpu" arguments and global properties: arguments to the -cpu
# option and global properties may affect expansion of CPU models.
-# Using query-cpu-model-expansion while using these is not advised.
+# Using `query-cpu-model-expansion` while using these is not advised.
#
# Some architectures may not support comparing CPU models. s390x
# supports comparing CPU models.
#
# @modela: description of the first CPU model to compare, referred to
-# as "model A" in CpuModelCompareResult
+# as "model A" in `CpuModelCompareResult`
#
# @modelb: description of the second CPU model to compare, referred to
-# as "model B" in CpuModelCompareResult
+# as "model B" in `CpuModelCompareResult`
#
-# Returns: a CpuModelCompareInfo describing how both CPU models
+# Returns: a `CpuModelCompareInfo` describing how both CPU models
# compare
#
# Errors:
@@ -2068,17 +2068,17 @@
#
# * QEMU version: CPU models may look different depending on the QEMU
# version. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * machine-type: CPU model may look different depending on the
# machine-type. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * machine options (including accelerator): in some architectures,
# CPU models may look different depending on machine and accelerator
# options. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * "-cpu" arguments and global properties: arguments to the -cpu
# option and global properties may affect expansion of CPU models.
-# Using query-cpu-model-expansion while using these is not advised.
+# Using `query-cpu-model-expansion` while using these is not advised.
#
# Some architectures may not support baselining CPU models. s390x
# supports baselining CPU models.
@@ -2087,7 +2087,7 @@
#
# @modelb: description of the second CPU model to baseline
#
-# Returns: a CpuModelBaselineInfo describing the baselined CPU model
+# Returns: a `CpuModelBaselineInfo` describing the baselined CPU model
#
# Errors:
# - if baselining CPU models is not supported by the target
@@ -2107,7 +2107,7 @@
#
# The result of a cpu model expansion.
#
-# @model: the expanded CpuModelInfo.
+# @model: the expanded `CpuModelInfo`.
#
# @deprecated-props: an optional list of properties that are flagged as
# deprecated by the CPU vendor. The list depends on the
@@ -2136,17 +2136,17 @@
#
# * QEMU version: CPU models may look different depending on the QEMU
# version. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * machine-type: CPU model may look different depending on the
# machine-type. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * machine options (including accelerator): in some architectures,
# CPU models may look different depending on machine and accelerator
# options. (Except for CPU models reported as "static" in
-# query-cpu-definitions.)
+# `query-cpu-definitions`.)
# * "-cpu" arguments and global properties: arguments to the -cpu
# option and global properties may affect expansion of CPU models.
-# Using query-cpu-model-expansion while using these is not advised.
+# Using `query-cpu-model-expansion` while using these is not advised.
#
# Some architectures may not support all expansion types. s390x
# supports "full" and "static". Arm only supports "full".
@@ -2155,7 +2155,7 @@
#
# @type: expansion type, specifying how to expand the CPU model
#
-# Returns: a CpuModelExpansionInfo describing the expanded CPU model
+# Returns: a `CpuModelExpansionInfo` describing the expanded CPU model
#
# Errors:
# - if expanding CPU models is not supported
@@ -2194,7 +2194,7 @@
# from running in the current host. (since 2.8)
#
# @typename: Type name that can be used as argument to
-# @device-list-properties, to introspect properties configurable
+# `device-list-properties`, to introspect properties configurable
# using -cpu or -global. (since 2.9)
#
# @alias-of: Name of CPU model this model is an alias for. The target
--
2.49.0
