[PATCH 0/2] docs/devel/qapi-code-gen: Update features doc, minor improvements

[PATCH 0/2] docs/devel/qapi-code-gen: Update features doc, minor improvements

[Markus Armbruster]

*** BLURB HERE ***

Markus Armbruster (2):
  docs/devel/qapi-code-gen: Belatedly update features documentation
  docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo

 docs/devel/qapi-code-gen.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

-- 
2.39.0

[PATCH 1/2] docs/devel/qapi-code-gen: Belatedly update features documentation

[Markus Armbruster]

Commit 013b4efc9be "qapi: Add feature flags to remaining
definitions" (v5.0.0), commit 84ab0086879 "qapi: Add feature flags to
struct members" (v5.0.0), and commit b6c18755e41 "qapi: Add feature
flags to enum members" (v6.2.0) neglected to update section
"Features".  Make up for that.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/devel/qapi-code-gen.rst | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index 5edc49aa74..566640edf8 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -685,9 +685,10 @@ change in the QMP syntax (usually by allowing values or operations
 that previously resulted in an error).  QMP clients may still need to
 know whether the extension is available.
 
-For this purpose, a list of features can be specified for a command or
-struct type.  Each list member can either be ``{ 'name': STRING, '*if':
-COND }``, or STRING, which is shorthand for ``{ 'name': STRING }``.
+For this purpose, a list of features can be specified for definitions,
+enumeration values, and struct members.  Each feature list member can
+either be ``{ 'name': STRING, '*if': COND }``, or STRING, which is
+shorthand for ``{ 'name': STRING }``.
 
 The optional 'if' member specifies a conditional.  See `Configuring
 the schema`_ below for more on this.
-- 
2.39.0

Re: [PATCH 1/2] docs/devel/qapi-code-gen: Belatedly update features documentation

[Eric Blake]

On Mon, Feb 13, 2023 at 02:20:08PM +0100, Markus Armbruster wrote:
> Commit 013b4efc9be "qapi: Add feature flags to remaining
> definitions" (v5.0.0), commit 84ab0086879 "qapi: Add feature flags to
> struct members" (v5.0.0), and commit b6c18755e41 "qapi: Add feature
> flags to enum members" (v6.2.0) neglected to update section
> "Features".  Make up for that.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  docs/devel/qapi-code-gen.rst | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org

[PATCH 2/2] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo

[Markus Armbruster]

Documentation of enumeration value conditions lacks a 'may'.  Fix
that.

Clarify SchemaInfo documentation for struct and union types.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/devel/qapi-code-gen.rst | 9 ++++-----
 1 file changed, 4 insertions(+), 5 deletions(-)

diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst
index 566640edf8..23e7f2fb1c 100644
--- a/docs/devel/qapi-code-gen.rst
+++ b/docs/devel/qapi-code-gen.rst
@@ -818,8 +818,8 @@ member 'bar' ::
 
 A union's discriminator may not be conditional.
 
-Likewise, individual enumeration values be conditional.  This requires
-the longhand form of ENUM-VALUE_.
+Likewise, individual enumeration values may be conditional.  This
+requires the longhand form of ENUM-VALUE_.
 
 Example: an enum type with unconditional value 'foo' and conditional
 value 'bar' ::
@@ -1158,9 +1158,8 @@ Example: the SchemaInfo for EVENT_C from section Events_ ::
     Type "q_obj-EVENT_C-arg" is an implicitly defined object type with
     the two members from the event's definition.
 
-The SchemaInfo for struct and union types has meta-type "object".
-
-The SchemaInfo for a struct type has variant member "members".
+The SchemaInfo for struct and union types has meta-type "object" and
+variant member "members".
 
 The SchemaInfo for a union type additionally has variant members "tag"
 and "variants".
-- 
2.39.0

Re: [PATCH 2/2] docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo

[Eric Blake]

On Mon, Feb 13, 2023 at 02:20:09PM +0100, Markus Armbruster wrote:
> Documentation of enumeration value conditions lacks a 'may'.  Fix
> that.
> 
> Clarify SchemaInfo documentation for struct and union types.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  docs/devel/qapi-code-gen.rst | 9 ++++-----
>  1 file changed, 4 insertions(+), 5 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3266
Virtualization:  qemu.org | libvirt.org

Re: [PATCH 0/2] docs/devel/qapi-code-gen: Update features doc, minor improvements

[John Snow]

[-- Attachment #1: Type: text/plain, Size: 418 bytes --]

On Mon, Feb 13, 2023, 8:20 AM Markus Armbruster <armbru@redhat.com> wrote:

> *** BLURB HERE ***
>

🤫


> Markus Armbruster (2):
>   docs/devel/qapi-code-gen: Belatedly update features documentation
>   docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo
>
>  docs/devel/qapi-code-gen.rst | 16 ++++++++--------
>  1 file changed, 8 insertions(+), 8 deletions(-)
>
> --
> 2.39.0
>
>

[-- Attachment #2: Type: text/html, Size: 964 bytes --]

Re: [PATCH 0/2] docs/devel/qapi-code-gen: Update features doc, minor improvements

[John Snow]

[-- Attachment #1: Type: text/plain, Size: 585 bytes --]

On Tue, Feb 14, 2023, 11:49 AM John Snow <jsnow@redhat.com> wrote:

>
>
> On Mon, Feb 13, 2023, 8:20 AM Markus Armbruster <armbru@redhat.com> wrote:
>
>> *** BLURB HERE ***
>>
>
> 🤫
>
>
>> Markus Armbruster (2):
>>   docs/devel/qapi-code-gen: Belatedly update features documentation
>>   docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo
>>
>>  docs/devel/qapi-code-gen.rst | 16 ++++++++--------
>>  1 file changed, 8 insertions(+), 8 deletions(-)
>>
>> --
>> 2.39.0
>>
>
Oops, also meant to add:

Reviewed-by: John Snow <jsnow@redhat.com>

[-- Attachment #2: Type: text/html, Size: 1539 bytes --]

Re: [PATCH 0/2] docs/devel/qapi-code-gen: Update features doc, minor improvements

[Markus Armbruster]

John Snow <jsnow@redhat.com> writes:

> On Tue, Feb 14, 2023, 11:49 AM John Snow <jsnow@redhat.com> wrote:
>
>>
>>
>> On Mon, Feb 13, 2023, 8:20 AM Markus Armbruster <armbru@redhat.com> wrote:
>>
>>> *** BLURB HERE ***
>>>
>>
>> 🤫

Uh, thank you for following my written instructions literally, and...

>>> Markus Armbruster (2):
>>>   docs/devel/qapi-code-gen: Belatedly update features documentation
>>>   docs/devel/qapi-code-gen: Fix a missing 'may', clarify SchemaInfo
>>>
>>>  docs/devel/qapi-code-gen.rst | 16 ++++++++--------
>>>  1 file changed, 8 insertions(+), 8 deletions(-)
>>>
>>> --
>>> 2.39.0
>>>
>>
> Oops, also meant to add:
>
> Reviewed-by: John Snow <jsnow@redhat.com>

... thank you for reviewing!