diff mbox series

[v2,19/19] qapi/vfio: Rename VfioMigrationState to Qapi*, and drop prefix

Message ID 20240904111836.3273842-20-armbru@redhat.com (mailing list archive)
State New, archived
Headers show
Series qapi: Reduce use of 'prefix' | expand

Commit Message

Markus Armbruster Sept. 4, 2024, 11:18 a.m. UTC
QAPI's 'prefix' feature can make the connection between enumeration
type and its constants less than obvious.  It's best used with
restraint.

VfioMigrationState has a 'prefix' that overrides the generated
enumeration constants' prefix to QAPI_VFIO_MIGRATION_STATE.

We could simply drop 'prefix', but then the enumeration constants
would look as if they came from kernel header linux/vfio.h.

Rename the type to QapiVfioMigrationState instead, so that 'prefix' is
not needed.

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/vfio.json      | 9 ++++-----
 hw/vfio/migration.c | 2 +-
 2 files changed, 5 insertions(+), 6 deletions(-)

Comments

Cédric Le Goater Sept. 4, 2024, 11:59 a.m. UTC | #1
On 9/4/24 13:18, Markus Armbruster wrote:
> QAPI's 'prefix' feature can make the connection between enumeration
> type and its constants less than obvious.  It's best used with
> restraint.
> 
> VfioMigrationState has a 'prefix' that overrides the generated
> enumeration constants' prefix to QAPI_VFIO_MIGRATION_STATE.
> 
> We could simply drop 'prefix', but then the enumeration constants
> would look as if they came from kernel header linux/vfio.h.
> 
> Rename the type to QapiVfioMigrationState instead, so that 'prefix' is
> not needed.
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>


Reviewed-by: Cédric Le Goater <clg@redhat.com>

Thanks,

C.


> ---
>   qapi/vfio.json      | 9 ++++-----
>   hw/vfio/migration.c | 2 +-
>   2 files changed, 5 insertions(+), 6 deletions(-)
> 
> diff --git a/qapi/vfio.json b/qapi/vfio.json
> index eccca82068..b53b7caecd 100644
> --- a/qapi/vfio.json
> +++ b/qapi/vfio.json
> @@ -7,7 +7,7 @@
>   ##
>   
>   ##
> -# @VfioMigrationState:
> +# @QapiVfioMigrationState:
>   #
>   # An enumeration of the VFIO device migration states.
>   #
> @@ -32,10 +32,9 @@
>   #
>   # Since: 9.1
>   ##
> -{ 'enum': 'VfioMigrationState',
> +{ 'enum': 'QapiVfioMigrationState',
>     'data': [ 'stop', 'running', 'stop-copy', 'resuming', 'running-p2p',
> -            'pre-copy', 'pre-copy-p2p' ],
> -  'prefix': 'QAPI_VFIO_MIGRATION_STATE' }
> +            'pre-copy', 'pre-copy-p2p' ] }
>   
>   ##
>   # @VFIO_MIGRATION:
> @@ -63,5 +62,5 @@
>     'data': {
>         'device-id': 'str',
>         'qom-path': 'str',
> -      'device-state': 'VfioMigrationState'
> +      'device-state': 'QapiVfioMigrationState'
>     } }
> diff --git a/hw/vfio/migration.c b/hw/vfio/migration.c
> index 262d42a46e..17199b73ae 100644
> --- a/hw/vfio/migration.c
> +++ b/hw/vfio/migration.c
> @@ -81,7 +81,7 @@ static const char *mig_state_to_str(enum vfio_device_mig_state state)
>       }
>   }
>   
> -static VfioMigrationState
> +static QapiVfioMigrationState
>   mig_state_to_qapi_state(enum vfio_device_mig_state state)
>   {
>       switch (state) {
diff mbox series

Patch

diff --git a/qapi/vfio.json b/qapi/vfio.json
index eccca82068..b53b7caecd 100644
--- a/qapi/vfio.json
+++ b/qapi/vfio.json
@@ -7,7 +7,7 @@ 
 ##
 
 ##
-# @VfioMigrationState:
+# @QapiVfioMigrationState:
 #
 # An enumeration of the VFIO device migration states.
 #
@@ -32,10 +32,9 @@ 
 #
 # Since: 9.1
 ##
-{ 'enum': 'VfioMigrationState',
+{ 'enum': 'QapiVfioMigrationState',
   'data': [ 'stop', 'running', 'stop-copy', 'resuming', 'running-p2p',
-            'pre-copy', 'pre-copy-p2p' ],
-  'prefix': 'QAPI_VFIO_MIGRATION_STATE' }
+            'pre-copy', 'pre-copy-p2p' ] }
 
 ##
 # @VFIO_MIGRATION:
@@ -63,5 +62,5 @@ 
   'data': {
       'device-id': 'str',
       'qom-path': 'str',
-      'device-state': 'VfioMigrationState'
+      'device-state': 'QapiVfioMigrationState'
   } }
diff --git a/hw/vfio/migration.c b/hw/vfio/migration.c
index 262d42a46e..17199b73ae 100644
--- a/hw/vfio/migration.c
+++ b/hw/vfio/migration.c
@@ -81,7 +81,7 @@  static const char *mig_state_to_str(enum vfio_device_mig_state state)
     }
 }
 
-static VfioMigrationState
+static QapiVfioMigrationState
 mig_state_to_qapi_state(enum vfio_device_mig_state state)
 {
     switch (state) {