[PATCH 0/2] qapi: Doc fixes

[PATCH 0/2] qapi: Doc fixes

[Markus Armbruster]

John, this trivially conflicts with your work.  Feel free to leave
resolving the conflicts to me.

Machine core maintainers, feel free to ignore this mini-series
entirely.

Markus Armbruster (2):
  qapi/machine: Drop misleading (for OptsVisitor) doc
  qapi/compat: Belatedly update description of CompatPolicy

 qapi/compat.json  | 2 +-
 qapi/machine.json | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

-- 
2.55.0

[PATCH 1/2] qapi/machine: Drop misleading (for OptsVisitor) doc

[Markus Armbruster]

The QMP Reference Manual describes NumaOptions and NumaNodeOptions as
"(for OptsVisitor)".  This makes no sense; the OptsVisitor is a purely
internal thing.

When commit 0042109a6a (NUMA: convert -numa option to use OptsVisitor)
added these QAPI types, both "(for OptsVisitor)" were correct and
merely schema comments.  They have since become wrong (both types are
part of QMP according to query-qmp-schema) and reference
documentation.

Delete both instances.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/machine.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qapi/machine.json b/qapi/machine.json
index 2d63c1bac3..2fd4861616 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -470,7 +470,7 @@
 ##
 # @NumaOptions:
 #
-# A discriminated record of NUMA options.  (for OptsVisitor)
+# A discriminated record of NUMA options.
 #
 # @type: NUMA option type
 #
@@ -489,7 +489,7 @@
 ##
 # @NumaNodeOptions:
 #
-# Create a guest NUMA node.  (for OptsVisitor)
+# Create a guest NUMA node.
 #
 # @nodeid: NUMA node ID (increase by 1 from 0 if omitted)
 #
-- 
2.55.0

[PATCH 2/2] qapi/compat: Belatedly update description of CompatPolicy

[Markus Armbruster]

Fixes: 57df0dff1a (qapi: Extend -compat to set policy for unstable
interfaces)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/compat.json | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/qapi/compat.json b/qapi/compat.json
index 90b8d51cf2..e4728424de 100644
--- a/qapi/compat.json
+++ b/qapi/compat.json
@@ -40,7 +40,7 @@
 ##
 # @CompatPolicy:
 #
-# Policy for handling deprecated management interfaces.
+# Policy for handling deprecated and unstable management interfaces.
 #
 # This is intended for testing users of the management interfaces.
 #
-- 
2.55.0

Re: [PATCH 1/2] qapi/machine: Drop misleading (for OptsVisitor) doc

[Daniel P. Berrangé]

On Fri, Sep 11, 2026 at 11:53:49AM +0200, Markus Armbruster wrote:
> The QMP Reference Manual describes NumaOptions and NumaNodeOptions as
> "(for OptsVisitor)".  This makes no sense; the OptsVisitor is a purely
> internal thing.
> 
> When commit 0042109a6a (NUMA: convert -numa option to use OptsVisitor)
> added these QAPI types, both "(for OptsVisitor)" were correct and
> merely schema comments.  They have since become wrong (both types are
> part of QMP according to query-qmp-schema) and reference
> documentation.
> 
> Delete both instances.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/machine.json | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com       ~~        https://hachyderm.io/@berrange :|
|: https://libvirt.org          ~~          https://entangle-photo.org :|
|: https://pixelfed.art/berrange   ~~    https://fstop138.berrange.com :|

Re: [PATCH 2/2] qapi/compat: Belatedly update description of CompatPolicy

[Daniel P. Berrangé]

On Fri, Sep 11, 2026 at 11:53:50AM +0200, Markus Armbruster wrote:
> Fixes: 57df0dff1a (qapi: Extend -compat to set policy for unstable
> interfaces)
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/compat.json | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)

Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>


With regards,
Daniel
-- 
|: https://berrange.com       ~~        https://hachyderm.io/@berrange :|
|: https://libvirt.org          ~~          https://entangle-photo.org :|
|: https://pixelfed.art/berrange   ~~    https://fstop138.berrange.com :|