diff mbox series

qapi: Belatedly update CompatPolicy documentation for unstable

Message ID 20231009110449.4015601-1-armbru@redhat.com
State New
Headers show
Series qapi: Belatedly update CompatPolicy documentation for unstable | expand

Commit Message

Markus Armbruster Oct. 9, 2023, 11:04 a.m. UTC
Commit 57df0dff1a1 (qapi: Extend -compat to set policy for unstable
interfaces) neglected to update the "Limitation" paragraph to mention
feature 'unstable' in addition to feature 'deprecated'.  Do that now.

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

Comments

Philippe Mathieu-Daudé Oct. 9, 2023, 11:19 a.m. UTC | #1
On 9/10/23 13:04, Markus Armbruster wrote:
> Commit 57df0dff1a1 (qapi: Extend -compat to set policy for unstable
> interfaces) neglected to update the "Limitation" paragraph to mention

With retrospective, 'experimental' seems more meaningful. Anyway,
too  late.

> feature 'unstable' in addition to feature 'deprecated'.  Do that now.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/compat.json | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/qapi/compat.json b/qapi/compat.json
> index f4c19837eb..42034d9368 100644
> --- a/qapi/compat.json
> +++ b/qapi/compat.json
> @@ -43,8 +43,8 @@
>   # This is intended for testing users of the management interfaces.
>   #
>   # Limitation: covers only syntactic aspects of QMP, i.e. stuff tagged
> -# with feature 'deprecated'.  We may want to extend it to cover
> -# semantic aspects and CLI.
> +# with feature 'deprecated' or 'unstable'.  We may want to extend it
> +# to cover semantic aspects and CLI.

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Markus Armbruster Oct. 9, 2023, 11:46 a.m. UTC | #2
Philippe Mathieu-Daudé <philmd@linaro.org> writes:

> On 9/10/23 13:04, Markus Armbruster wrote:
>> Commit 57df0dff1a1 (qapi: Extend -compat to set policy for unstable
>> interfaces) neglected to update the "Limitation" paragraph to mention
>
> With retrospective, 'experimental' seems more meaningful. Anyway,
> too  late.

Experiments are a major use for interfaces without stability promise,
but there's also debugging aids and such.

>> feature 'unstable' in addition to feature 'deprecated'.  Do that now.
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>   qapi/compat.json | 4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>> diff --git a/qapi/compat.json b/qapi/compat.json
>> index f4c19837eb..42034d9368 100644
>> --- a/qapi/compat.json
>> +++ b/qapi/compat.json
>> @@ -43,8 +43,8 @@
>>   # This is intended for testing users of the management interfaces.
>>   #
>>   # Limitation: covers only syntactic aspects of QMP, i.e. stuff tagged
>> -# with feature 'deprecated'.  We may want to extend it to cover
>> -# semantic aspects and CLI.
>> +# with feature 'deprecated' or 'unstable'.  We may want to extend it
>> +# to cover semantic aspects and CLI.
>
> Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>

Thanks!
Markus Armbruster Oct. 16, 2023, 10:52 a.m. UTC | #3
Markus Armbruster <armbru@redhat.com> writes:

> Commit 57df0dff1a1 (qapi: Extend -compat to set policy for unstable
> interfaces) neglected to update the "Limitation" paragraph to mention
> feature 'unstable' in addition to feature 'deprecated'.  Do that now.
>
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

Queued.
diff mbox series

Patch

diff --git a/qapi/compat.json b/qapi/compat.json
index f4c19837eb..42034d9368 100644
--- a/qapi/compat.json
+++ b/qapi/compat.json
@@ -43,8 +43,8 @@ 
 # This is intended for testing users of the management interfaces.
 #
 # Limitation: covers only syntactic aspects of QMP, i.e. stuff tagged
-# with feature 'deprecated'.  We may want to extend it to cover
-# semantic aspects and CLI.
+# with feature 'deprecated' or 'unstable'.  We may want to extend it
+# to cover semantic aspects and CLI.
 #
 # Limitation: deprecated-output policy @hide is not implemented for
 # enumeration values.  They behave the same as with policy @accept.