[v1] qapi/machine: Place the 'Notes' tag after the 'Since' tag

[PATCH] qapi/machine: Place the 'Notes' tag after the 'Since' tag

Posted by Philippe Mathieu-Daudé 5 years, 8 months ago

This fixes when adding a 'Since' tag:

  In file included from qapi/qapi-schema.json:105:
  qapi/machine.json:25:1: '@arch:' can't follow 'Notes' section

Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
---
 qapi/machine.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qapi/machine.json b/qapi/machine.json
index 6c11e3cf3a..2b4f5f0962 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -16,11 +16,11 @@
 # individual target constants are not documented here, for the time
 # being.
 #
+# Since: 3.0
+#
 # Notes: The resulting QMP strings can be appended to the "qemu-system-"
 #        prefix to produce the corresponding QEMU executable name. This
 #        is true even for "qemu-system-x86_64".
-#
-# Since: 3.0
 ##
 { 'enum' : 'SysEmuTarget',
   'data' : [ 'aarch64', 'alpha', 'arm', 'cris', 'hppa', 'i386', 'lm32',
-- 
2.21.1

Re: [PATCH] qapi/machine: Place the 'Notes' tag after the 'Since' tag

Posted by Liam Merwick 5 years, 8 months ago

On 27/02/2020 10:41, Philippe Mathieu-Daudé wrote:
> This fixes when adding a 'Since' tag:
> 
>    In file included from qapi/qapi-schema.json:105:
>    qapi/machine.json:25:1: '@arch:' can't follow 'Notes' section
> 
> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
> ---
>   qapi/machine.json | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 6c11e3cf3a..2b4f5f0962 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -16,11 +16,11 @@
>   # individual target constants are not documented here, for the time
>   # being.
>   #
> +# Since: 3.0
> +#
>   # Notes: The resulting QMP strings can be appended to the "qemu-system-"
>   #        prefix to produce the corresponding QEMU executable name. This
>   #        is true even for "qemu-system-x86_64".
> -#
> -# Since: 3.0
>   ##
>   { 'enum' : 'SysEmuTarget',
>     'data' : [ 'aarch64', 'alpha', 'arm', 'cris', 'hppa', 'i386', 'lm32',
> 


Does the same issue occur for @CpuInstanceProperties: at line 829?
The 'Since:' follows a 'Note:' section (but maybe the singular usage is 
intended).

otherwise

Reviewed-by: Liam Merwick <liam.merwick@oracle.com>

Re: [PATCH] qapi/machine: Place the 'Notes' tag after the 'Since' tag

Posted by Philippe Mathieu-Daudé 5 years, 8 months ago

On 2/27/20 12:59 PM, Liam Merwick wrote:
> On 27/02/2020 10:41, Philippe Mathieu-Daudé wrote:
>> This fixes when adding a 'Since' tag:
>>
>>    In file included from qapi/qapi-schema.json:105:
>>    qapi/machine.json:25:1: '@arch:' can't follow 'Notes' section
>>
>> Signed-off-by: Philippe Mathieu-Daudé <philmd@redhat.com>
>> ---
>>   qapi/machine.json | 4 ++--
>>   1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/qapi/machine.json b/qapi/machine.json
>> index 6c11e3cf3a..2b4f5f0962 100644
>> --- a/qapi/machine.json
>> +++ b/qapi/machine.json
>> @@ -16,11 +16,11 @@
>>   # individual target constants are not documented here, for the time
>>   # being.
>>   #
>> +# Since: 3.0
>> +#
>>   # Notes: The resulting QMP strings can be appended to the 
>> "qemu-system-"
>>   #        prefix to produce the corresponding QEMU executable name. This
>>   #        is true even for "qemu-system-x86_64".
>> -#
>> -# Since: 3.0
>>   ##
>>   { 'enum' : 'SysEmuTarget',
>>     'data' : [ 'aarch64', 'alpha', 'arm', 'cris', 'hppa', 'i386', 'lm32',
>>
> 
> 
> Does the same issue occur for @CpuInstanceProperties: at line 829?
> The 'Since:' follows a 'Note:' section (but maybe the singular usage is 
> intended).

Ah thanks for checking other cases. Yes, the same error should occur.

> 
> otherwise
> 
> Reviewed-by: Liam Merwick <liam.merwick@oracle.com>

Thanks! I'll respin with the other entry fixed.