qapi: Enforce naming rules

[PATCH 20/28] qapi/pragma: Streamline comments on member-name-exceptions

Posted by Markus Armbruster 4 years, 10 months ago

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/pragma.json | 16 +++++++++-------
 1 file changed, 9 insertions(+), 7 deletions(-)

diff --git a/qapi/pragma.json b/qapi/pragma.json
index 4895848c5e..4c47c802d1 100644
--- a/qapi/pragma.json
+++ b/qapi/pragma.json
@@ -10,11 +10,13 @@
         'query-tpm-models',
         'query-tpm-types',
         'ringbuf-read' ],
-    'member-name-exceptions': [
-        'ACPISlotType',             # DIMM, visible through query-acpi-ospm-status
-        'BlockdevVmdkSubformat',    # all members, to match VMDK spec spellings
-        'BlockdevVmdkAdapterType',  # legacyESX, to match VMDK spec spellings
-        'QapiErrorClass',           # all members, visible through errors
-        'UuidInfo',                 # UUID, visible through query-uuid
-        'X86CPURegister32'          # all members, visible indirectly through qom-get
+    # Externally visible types whose member names may use uppercase
+    'member-name-exceptions': [     # visible in:
+        'ACPISlotType',             # query-acpi-ospm-status
+        'BlockdevVmdkAdapterType',  # blockdev-create (to match VMDK spec)
+        'BlockdevVmdkSubformat',    # blockdev-create (to match VMDK spec)
+        'QapiErrorClass',           # QMP error replies
+        'UuidInfo',                 # query-uuid
+        'X86CPURegister32'          # qom-get of x86 CPU properties
+                                    # feature-words, filtered-features
     ] } }
-- 
2.26.3

Re: [PATCH 20/28] qapi/pragma: Streamline comments on member-name-exceptions

Posted by Eric Blake 4 years, 10 months ago

On 3/23/21 4:40 AM, Markus Armbruster wrote:
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>  qapi/pragma.json | 16 +++++++++-------
>  1 file changed, 9 insertions(+), 7 deletions(-)
> 

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

> diff --git a/qapi/pragma.json b/qapi/pragma.json
> index 4895848c5e..4c47c802d1 100644
> --- a/qapi/pragma.json
> +++ b/qapi/pragma.json
> @@ -10,11 +10,13 @@
>          'query-tpm-models',
>          'query-tpm-types',
>          'ringbuf-read' ],
> -    'member-name-exceptions': [
> -        'ACPISlotType',             # DIMM, visible through query-acpi-ospm-status
> -        'BlockdevVmdkSubformat',    # all members, to match VMDK spec spellings
> -        'BlockdevVmdkAdapterType',  # legacyESX, to match VMDK spec spellings
> -        'QapiErrorClass',           # all members, visible through errors
> -        'UuidInfo',                 # UUID, visible through query-uuid
> -        'X86CPURegister32'          # all members, visible indirectly through qom-get
> +    # Externally visible types whose member names may use uppercase
> +    'member-name-exceptions': [     # visible in:
> +        'ACPISlotType',             # query-acpi-ospm-status
> +        'BlockdevVmdkAdapterType',  # blockdev-create (to match VMDK spec)
> +        'BlockdevVmdkSubformat',    # blockdev-create (to match VMDK spec)
> +        'QapiErrorClass',           # QMP error replies
> +        'UuidInfo',                 # query-uuid
> +        'X86CPURegister32'          # qom-get of x86 CPU properties
> +                                    # feature-words, filtered-features
>      ] } }
> 

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