diff options
| author | Markus Armbruster <armbru@redhat.com> | 2023-04-25 08:42:13 +0200 |
|---|---|---|
| committer | Markus Armbruster <armbru@redhat.com> | 2023-04-28 11:48:34 +0200 |
| commit | f1a787b5f4b60524580ed9d1527568590d73789b (patch) | |
| tree | 1fc43237c13bd9b9b6f91ad2b6356ab513d4557d /qapi | |
| parent | 9a5af2f9dc8f231f6ca20f61b95970380f1024e2 (diff) | |
qapi: @foo should be used to reference, not ``foo``
Documentation suggests @foo is merely shorthand for ``foo``. It's
not, it carries additional meaning: it's a reference to a QAPI schema
name.
Reword the documentation to spell that out.
Fix up the few ``foo`` that should be @foo.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20230425064223.820979-7-armbru@redhat.com>
Diffstat (limited to 'qapi')
| -rw-r--r-- | qapi/qom.json | 2 | ||||
| -rw-r--r-- | qapi/ui.json | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/qapi/qom.json b/qapi/qom.json index a877b879b9..4fe7a93a75 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -637,7 +637,7 @@ # # @discard-data: if true, the file contents can be destroyed when QEMU exits, # to avoid unnecessarily flushing data to the backing file. Note -# that ``discard-data`` is only an optimization, and QEMU might +# that @discard-data is only an optimization, and QEMU might # not discard file contents if it aborts unexpectedly or is # terminated using SIGKILL. (default: false) # diff --git a/qapi/ui.json b/qapi/ui.json index 2d9b34b105..2fa41c8ab0 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -1247,7 +1247,7 @@ # available node on the host. # # @p2p: Whether to use peer-to-peer connections (accepted through -# ``add_client``). +# @add_client). # # @audiodev: Use the specified DBus audiodev to export audio. # |