diff mbox series

[v7] docs: add test for firmware.json QAPI

Message ID 20240724-qapi-firmware-json-v7-1-12341f7e362d@linutronix.de (mailing list archive)
State New, archived
Headers show
Series [v7] docs: add test for firmware.json QAPI | expand

Commit Message

Thomas Weißschuh July 24, 2024, 12:45 p.m. UTC
To make sure that the QAPI description stays valid, add a testcase.

Suggested-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Link: https://lore.kernel.org/qemu-devel/d9ce0234-4beb-4b90-b14c-76810d3b81d7@linaro.org/
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Thomas Weißschuh <thomas.weissschuh@linutronix.de>
---
docs/interop/firmware.json is currently not usable with qapi-gen.py due
to various non-functional issues.
Fix those issue to provide compatibility.
---
Changes in v7:
- Drop already applied patches
- Remove "test_env" from docs/meson.build
- Remove explicit "python" invocation from docs/meson.build
- Validate patch through Gitlab CI
- Remove Hanna and Kevin from Cc again
- Link to v6: https://lore.kernel.org/r/20240719-qapi-firmware-json-v6-0-c2e3de390b58@linutronix.de

Changes in v6:
- Style cleanups
- Improve the comment for qcow2
- Document the new enums as Since: 3.0 (7.1 for the loongarch64 arch)
- Link to v5: https://lore.kernel.org/r/20240718-qapi-firmware-json-v5-0-0dba12d7aaf5@linutronix.de

Changes in v5:
- Add Reviewed-by from Daniel
- Add patch to drop Example section
- Link to v4: https://lore.kernel.org/r/20240718-qapi-firmware-json-v4-0-449ce672db5c@linutronix.de

Changes in v4:
- Update "since" to 9.1
- Add comment to 'member-name-exceptions'
- Document enum members and drop 'documentation-exceptions'
- Link to v3: https://lore.kernel.org/r/20240311-qapi-firmware-json-v3-0-ceea6e35eb4a@linutronix.de

Changes in v3:
- Drop already picked up patches
- Drop include of pragma.json
- Introduce new enums FirmwareFormat and FirmwareArchitecture
- Link to v2: https://lore.kernel.org/r/20240307-qapi-firmware-json-v2-0-3b29eabb9b9a@linutronix.de

Changes in v2:
- Add review tag from Philippe
- Add Fixes tag (Philippe)
- Add testcase (Philippe)
- Link to v1: https://lore.kernel.org/r/20240306-qapi-firmware-json-v1-0-619f7122a249@linutronix.de
---
 docs/meson.build | 5 +++++
 1 file changed, 5 insertions(+)


---
base-commit: 6410f877f5ed535acd01bbfaa4baec379e44d0ef
change-id: 20240306-qapi-firmware-json-6fb1213936dd

Best regards,

Comments

Philippe Mathieu-Daudé July 29, 2024, 2:30 p.m. UTC | #1
On 24/7/24 14:45, Thomas Weißschuh wrote:
> To make sure that the QAPI description stays valid, add a testcase.
> 
> Suggested-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> Link: https://lore.kernel.org/qemu-devel/d9ce0234-4beb-4b90-b14c-76810d3b81d7@linaro.org/
> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
> Acked-by: Markus Armbruster <armbru@redhat.com>
> Signed-off-by: Thomas Weißschuh <thomas.weissschuh@linutronix.de>
> ---
> docs/interop/firmware.json is currently not usable with qapi-gen.py due
> to various non-functional issues.
> Fix those issue to provide compatibility.
> ---
> Changes in v7:
> - Drop already applied patches
> - Remove "test_env" from docs/meson.build
> - Remove explicit "python" invocation from docs/meson.build
> - Validate patch through Gitlab CI
> - Remove Hanna and Kevin from Cc again
> - Link to v6: https://lore.kernel.org/r/20240719-qapi-firmware-json-v6-0-c2e3de390b58@linutronix.de
> 
> Changes in v6:
> - Style cleanups
> - Improve the comment for qcow2
> - Document the new enums as Since: 3.0 (7.1 for the loongarch64 arch)
> - Link to v5: https://lore.kernel.org/r/20240718-qapi-firmware-json-v5-0-0dba12d7aaf5@linutronix.de
> 
> Changes in v5:
> - Add Reviewed-by from Daniel
> - Add patch to drop Example section
> - Link to v4: https://lore.kernel.org/r/20240718-qapi-firmware-json-v4-0-449ce672db5c@linutronix.de
> 
> Changes in v4:
> - Update "since" to 9.1
> - Add comment to 'member-name-exceptions'
> - Document enum members and drop 'documentation-exceptions'
> - Link to v3: https://lore.kernel.org/r/20240311-qapi-firmware-json-v3-0-ceea6e35eb4a@linutronix.de
> 
> Changes in v3:
> - Drop already picked up patches
> - Drop include of pragma.json
> - Introduce new enums FirmwareFormat and FirmwareArchitecture
> - Link to v2: https://lore.kernel.org/r/20240307-qapi-firmware-json-v2-0-3b29eabb9b9a@linutronix.de
> 
> Changes in v2:
> - Add review tag from Philippe
> - Add Fixes tag (Philippe)
> - Add testcase (Philippe)
> - Link to v1: https://lore.kernel.org/r/20240306-qapi-firmware-json-v1-0-619f7122a249@linutronix.de
> ---
>   docs/meson.build | 5 +++++
>   1 file changed, 5 insertions(+)
> 
> diff --git a/docs/meson.build b/docs/meson.build
> index 9040f860ae1a..322452c87787 100644
> --- a/docs/meson.build
> +++ b/docs/meson.build
> @@ -99,3 +99,8 @@ if build_docs
>     alias_target('html', sphinxdocs)
>     alias_target('man', sphinxmans)
>   endif
> +
> +test('QAPI firmware.json regression tests', qapi_gen,
> +     args: ['-o', meson.current_build_dir() / 'qapi',
> +            meson.current_source_dir() / 'interop/firmware.json'],
> +     suite: ['qapi-schema', 'qapi-interop'])
> 
> ---

Tested-by: Philippe Mathieu-Daudé <philmd@linaro.org>

and queued, thanks!
diff mbox series

Patch

diff --git a/docs/meson.build b/docs/meson.build
index 9040f860ae1a..322452c87787 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -99,3 +99,8 @@  if build_docs
   alias_target('html', sphinxdocs)
   alias_target('man', sphinxmans)
 endif
+
+test('QAPI firmware.json regression tests', qapi_gen,
+     args: ['-o', meson.current_build_dir() / 'qapi',
+            meson.current_source_dir() / 'interop/firmware.json'],
+     suite: ['qapi-schema', 'qapi-interop'])