mbox series

[v6,0/4] docs/interop/firmware.json: scripts/qapi-gen.py compatibility

Message ID 20240719-qapi-firmware-json-v6-0-c2e3de390b58@linutronix.de (mailing list archive)
Headers show
Series docs/interop/firmware.json: scripts/qapi-gen.py compatibility | expand

Message

Thomas Weißschuh July 19, 2024, 7:37 a.m. UTC 
docs/interop/firmware.json is currently not usable with qapi-gen.py due
to various non-functional issues.
Fix those issue to provide compatibility.

Kashyap, I stuck with the original wording for image format docs,
as I personally prefer them a bit.

Signed-off-by: Thomas Weißschuh <thomas.weissschuh@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

---
Thomas Weißschuh (4):
      docs/interop/firmware.json: add new enum FirmwareFormat
      docs/interop/firmware.json: add new enum FirmwareArchitecture
      docs/interop/firmware.json: convert "Example" section
      docs: add test for firmware.json QAPI

 docs/interop/firmware.json | 47 +++++++++++++++++++++++++++++++++++++++++-----
 docs/meson.build           |  5 +++++
 2 files changed, 47 insertions(+), 5 deletions(-)
---
base-commit: 23fa74974d8c96bc95cbecc0d4e2d90f984939f6
change-id: 20240306-qapi-firmware-json-6fb1213936dd

Best regards,

Comments

Philippe Mathieu-Daudé July 19, 2024, 1:06 p.m. UTC | #1 
On 19/7/24 09:37, Thomas Weißschuh wrote:

> Thomas Weißschuh (4):
>        docs/interop/firmware.json: add new enum FirmwareFormat
>        docs/interop/firmware.json: add new enum FirmwareArchitecture
>        docs/interop/firmware.json: convert "Example" section
>        docs: add test for firmware.json QAPI

Thanks, series queued!