diff options
| author | John Snow <jsnow@redhat.com> | 2024-06-26 18:21:14 -0400 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2024-07-06 08:58:24 +0200 |
| commit | 9f2b848857fc2bd7f36802524ef89d149c77092c (patch) | |
| tree | 49104da1b262535ec0a7e441fe9576af3d482944 /qapi/machine.json | |
| parent | 2664f3176a85aff556e5d82ad4396bda67a20b39 (diff) | |
qapi: fix non-compliant JSON examples
The new QMP documentation generator wants to parse all examples as
"QMP". We have an existing QMP lexer in docs/sphinx/qmp_lexer.py (Seen
in-use here: https://qemu-project.gitlab.io/qemu/interop/bitmaps.html)
that allows the use of "->", "<-" and "..." tokens to denote QMP
protocol flow with elisions, but otherwise defers to the JSON lexer.
To utilize this lexer for the existing QAPI documentation, we need them
to conform to a standard so that they lex and render correctly. Once the
QMP lexer is active for examples, errant QMP/JSON will produce warning
messages and fail the build.
Fix any invalid JSON found in QAPI documentation (identified by
attempting to lex all examples as QMP; see subsequent
commits). Additionally, elisions must be standardized for the QMP lexer;
they must be represented as the value "...", so three examples have been
adjusted to support that format here.
Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20240626222128.406106-9-jsnow@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi/machine.json')
| -rw-r--r-- | qapi/machine.json | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/qapi/machine.json b/qapi/machine.json index 2fd3e9c3d5..a982c94503 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -1057,7 +1057,7 @@ # "vcpus-count": 1 }, # { "props": { "core-id": 0 }, "type": "POWER8-spapr-cpu-core", # "vcpus-count": 1, "qom-path": "/machine/unattached/device[0]"} -# ]}' +# ]} # # For pc machine type started with -smp 1,maxcpus=2: # |