Re: [Qemu-devel] [PATCH] qapi/migration.json: Fix documentation issue about query_colo_status

[Markus Armbruster]

"Zhang, Chen" <address@hidden> writes:

>> -----Original Message-----
>> From: Markus Armbruster [mailto:address@hidden
>> Sent: Tuesday, April 2, 2019 2:20 PM
>> To: Zhang, Chen <address@hidden>
>> Cc: Zhang Chen <address@hidden>; Dr. David Alan Gilbert
>> <address@hidden>; Juan Quintela <address@hidden>; zhanghailiang
>> <address@hidden>; Eric Blake <address@hidden>; qemu-
>> dev <address@hidden>; Zhang, Chen <address@hidden>
>> Subject: Re: [Qemu-devel] [PATCH] qapi/migration.json: Fix documentation
>> issue about query_colo_status
>> 
>> Zhang Chen <address@hidden > writes:
>> 
>> > From: Zhang Chen <address@hidden>
>> >
>> > The documentation with the wrong initial version number of last_mode
>> > field, This patch just fix this issue.
>> >
>> > Signed-off-by: Zhang Chen <address@hidden>
>> > ---
>> >  qapi/migration.json | 2 +-
>> >  1 file changed, 1 insertion(+), 1 deletion(-)
>> >
>> > diff --git a/qapi/migration.json b/qapi/migration.json index
>> > cfde29acf8..798c6ac2df 100644
>> > --- a/qapi/migration.json
>> > +++ b/qapi/migration.json
>> > @@ -1382,7 +1382,7 @@
>> >  #
>> >  # @last_mode: COLO last running mode. If COLO is running, this field
>> >  #             will return same like mode field, after failover we can
>> > -#             use this field to get last colo mode. (since 4.1)
>> > +#             use this field to get last colo mode. (since 4.0)
>> >  #
>> >  # @reason: describes the reason for the COLO exit.
>> >  #
>> 
>> What's the excuse for spelling last_mode with '_' instead of '-'?
>> 
>> Any objection to changing it to last-mode?
>
> No, I just found in migration.json have both '_' and  '-', for example 
> "migrate_cancel" and "migrate-continue".
> If you think we should use the '-' format in this migration.qapi file, I will 
> send a patch to change all command format to the '-'.

Quote docs/devel/qapi-code-gen.txt:

    Command names, and member names within a type, should be all lower
    case with words separated by a hyphen.  However, some existing older
    commands and complex types use underscore; when extending such
    expressions, consistency is preferred over blindly avoiding
    underscore.

The consistency argument doesn't apply here.

I'd prefer to have this cleaned up, and I'd prefer to have it done in
-rc2.  If I see a patch from you before I do my pull request, I'll use
it, otherweise I'll patch it myself.