qapi/migration: Add missing tls-authz documentation

[PATCH] qapi/migration: Add missing tls-authz documentation

Posted by peterx@redhat.com 9 months, 3 weeks ago

From: Peter Xu <peterx@redhat.com>

As reported in Markus's recent enforcement series on qapi doc [1], we
accidentally miss one entry for tls-authz.  Add it.  Then we can drop
@MigrateSetParameters from documentation-exceptions safely later.

[1] https://lore.kernel.org/r/20240205074709.3613229-1-armbru@redhat.com

Cc: Daniel P. Berrangé <berrange@redhat.com>
Cc: Fabiano Rosas <farosas@suse.de>
Reported-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Peter Xu <peterx@redhat.com>
---
 qapi/migration.json | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/qapi/migration.json b/qapi/migration.json
index 819708321d..f4c5f59e01 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -980,6 +980,10 @@
 #     2.9) Previously (since 2.7), this was reported by omitting
 #     tls-hostname instead.
 #
+# @tls-authz: ID of the 'authz' object subclass that provides access
+#     control checking of the TLS x509 certificate distinguished name.
+#     (Since 4.0)
+#
 # @max-bandwidth: to set maximum speed for migration.  maximum speed
 #     in bytes per second.  (Since 2.8)
 #
-- 
2.43.0

Re: [PATCH] qapi/migration: Add missing tls-authz documentation

Posted by Markus Armbruster 9 months, 3 weeks ago

peterx@redhat.com writes:

> From: Peter Xu <peterx@redhat.com>
>
> As reported in Markus's recent enforcement series on qapi doc [1], we
> accidentally miss one entry for tls-authz.  Add it.  Then we can drop
> @MigrateSetParameters from documentation-exceptions safely later.
>
> [1] https://lore.kernel.org/r/20240205074709.3613229-1-armbru@redhat.com
>
> Cc: Daniel P. Berrangé <berrange@redhat.com>
> Cc: Fabiano Rosas <farosas@suse.de>
> Reported-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Peter Xu <peterx@redhat.com>
> ---
>  qapi/migration.json | 4 ++++
>  1 file changed, 4 insertions(+)
>
> diff --git a/qapi/migration.json b/qapi/migration.json
> index 819708321d..f4c5f59e01 100644
> --- a/qapi/migration.json
> +++ b/qapi/migration.json
> @@ -980,6 +980,10 @@
>  #     2.9) Previously (since 2.7), this was reported by omitting
>  #     tls-hostname instead.
>  #
> +# @tls-authz: ID of the 'authz' object subclass that provides access
> +#     control checking of the TLS x509 certificate distinguished name.
> +#     (Since 4.0)
> +#
>  # @max-bandwidth: to set maximum speed for migration.  maximum speed
>  #     in bytes per second.  (Since 2.8)
>  #

Reviewed-by: Markus Armbruster <armbru@redhat.com>

I propose I queue this right after [1] with the update to pragma.json
squashed in (appended), and the sentence "Then we can drop ... later"
dropped.

Thanks for your help!


diff --git a/qapi/pragma.json b/qapi/pragma.json
index 7ac05ccc26..6929ab776e 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -69,7 +69,6 @@
         'JSONType',
         'KeyValueKind',
         'MemoryDeviceInfoKind',
-        'MigrateSetParameters',
         'NetClientDriver',
         'ObjectType',
         'PciMemoryRegion',

Re: [PATCH] qapi/migration: Add missing tls-authz documentation

Posted by Peter Xu 9 months, 3 weeks ago

On Wed, Feb 07, 2024 at 07:07:58AM +0100, Markus Armbruster wrote:
> peterx@redhat.com writes:
> 
> > From: Peter Xu <peterx@redhat.com>
> >
> > As reported in Markus's recent enforcement series on qapi doc [1], we
> > accidentally miss one entry for tls-authz.  Add it.  Then we can drop
> > @MigrateSetParameters from documentation-exceptions safely later.
> >
> > [1] https://lore.kernel.org/r/20240205074709.3613229-1-armbru@redhat.com
> >
> > Cc: Daniel P. Berrangé <berrange@redhat.com>
> > Cc: Fabiano Rosas <farosas@suse.de>
> > Reported-by: Markus Armbruster <armbru@redhat.com>
> > Signed-off-by: Peter Xu <peterx@redhat.com>
> > ---
> >  qapi/migration.json | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/qapi/migration.json b/qapi/migration.json
> > index 819708321d..f4c5f59e01 100644
> > --- a/qapi/migration.json
> > +++ b/qapi/migration.json
> > @@ -980,6 +980,10 @@
> >  #     2.9) Previously (since 2.7), this was reported by omitting
> >  #     tls-hostname instead.
> >  #
> > +# @tls-authz: ID of the 'authz' object subclass that provides access
> > +#     control checking of the TLS x509 certificate distinguished name.
> > +#     (Since 4.0)
> > +#
> >  # @max-bandwidth: to set maximum speed for migration.  maximum speed
> >  #     in bytes per second.  (Since 2.8)
> >  #
> 
> Reviewed-by: Markus Armbruster <armbru@redhat.com>
> 
> I propose I queue this right after [1] with the update to pragma.json
> squashed in (appended), and the sentence "Then we can drop ... later"
> dropped.
> 
> Thanks for your help!
> 
> 
> diff --git a/qapi/pragma.json b/qapi/pragma.json
> index 7ac05ccc26..6929ab776e 100644
> --- a/qapi/pragma.json
> +++ b/qapi/pragma.json
> @@ -69,7 +69,6 @@
>          'JSONType',
>          'KeyValueKind',
>          'MemoryDeviceInfoKind',
> -        'MigrateSetParameters',
>          'NetClientDriver',
>          'ObjectType',
>          'PciMemoryRegion',
> 

Yes, please.

Or queue this prior to that series, then below diff can be squashed into
the other patch; either way works.

Thanks Markus!

-- 
Peter Xu