[v1] A QAPI schema doc markup fix, and style cleanup

[PATCH 8/8] docs/interop: Add test to keep vhost-user.json sane

Posted by Markus Armbruster 2 weeks ago

We did this for firmware.json in commit d4181658dfb (docs: add test
for firmware.json QAPI).

Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 docs/meson.build | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/docs/meson.build b/docs/meson.build
index 3676f81c4d..7e54b01e6a 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -99,7 +99,12 @@ if build_docs
   alias_target('man', sphinxmans)
 endif
 
-test('QAPI firmware.json regression tests', qapi_gen,
-     args: ['-o', meson.current_build_dir() / 'qapi',
+test('QAPI firmware.json regression test', qapi_gen,
+     args: ['-o', meson.current_build_dir() / 'qapi-firmware',
             meson.current_source_dir() / 'interop/firmware.json'],
      suite: ['qapi-schema', 'qapi-interop'])
+
+test('QAPI vhost-user.json regression test', qapi_gen,
+     args: ['-o', meson.current_build_dir() / 'qapi-vhost-user',
+            meson.current_source_dir() / 'interop/vhost-user.json'],
+     suite: ['qapi-schema', 'qapi-interop'])
-- 
2.49.0

Re: [PATCH 8/8] docs/interop: Add test to keep vhost-user.json sane

Posted by Vladimir Sementsov-Ogievskiy 2 weeks ago

On 31.10.25 12:47, Markus Armbruster wrote:
> We did this for firmware.json in commit d4181658dfb (docs: add test
> for firmware.json QAPI).
> 
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   docs/meson.build | 9 +++++++--
>   1 file changed, 7 insertions(+), 2 deletions(-)
> 
> diff --git a/docs/meson.build b/docs/meson.build
> index 3676f81c4d..7e54b01e6a 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -99,7 +99,12 @@ if build_docs
>     alias_target('man', sphinxmans)
>   endif
>   
> -test('QAPI firmware.json regression tests', qapi_gen,
> -     args: ['-o', meson.current_build_dir() / 'qapi',
> +test('QAPI firmware.json regression test', qapi_gen,
> +     args: ['-o', meson.current_build_dir() / 'qapi-firmware',
>               meson.current_source_dir() / 'interop/firmware.json'],
>        suite: ['qapi-schema', 'qapi-interop'])
> +
> +test('QAPI vhost-user.json regression test', qapi_gen,
> +     args: ['-o', meson.current_build_dir() / 'qapi-vhost-user',
> +            meson.current_source_dir() / 'interop/vhost-user.json'],
> +     suite: ['qapi-schema', 'qapi-interop'])

Hmm, if we have more .json files in docs, we'll need some more
convenient and safe way to cover them all.


Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Tested-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

-- 
Best regards,
Vladimir

Re: [PATCH 8/8] docs/interop: Add test to keep vhost-user.json sane

Posted by Markus Armbruster 2 weeks ago

Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> writes:

> On 31.10.25 12:47, Markus Armbruster wrote:
>> We did this for firmware.json in commit d4181658dfb (docs: add test
>> for firmware.json QAPI).
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>> ---
>>   docs/meson.build | 9 +++++++--
>>   1 file changed, 7 insertions(+), 2 deletions(-)
>> diff --git a/docs/meson.build b/docs/meson.build
>> index 3676f81c4d..7e54b01e6a 100644
>> --- a/docs/meson.build
>> +++ b/docs/meson.build
>> @@ -99,7 +99,12 @@ if build_docs
>>    alias_target('man', sphinxmans)
>>  endif
>> -test('QAPI firmware.json regression tests', qapi_gen,
>> -     args: ['-o', meson.current_build_dir() / 'qapi',
>> +test('QAPI firmware.json regression test', qapi_gen,
>> +     args: ['-o', meson.current_build_dir() / 'qapi-firmware',
>>              meson.current_source_dir() / 'interop/firmware.json'],
>>       suite: ['qapi-schema', 'qapi-interop'])
>> +
>> +test('QAPI vhost-user.json regression test', qapi_gen,
>> +     args: ['-o', meson.current_build_dir() / 'qapi-vhost-user',
>> +            meson.current_source_dir() / 'interop/vhost-user.json'],
>> +     suite: ['qapi-schema', 'qapi-interop'])
>
> Hmm, if we have more .json files in docs, we'll need some more
> convenient and safe way to cover them all.

Yes.  But so far it's just these two, and they're from 2018 and 2019.

> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
> Tested-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

Thanks!