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 /docs/interop | |
parent | 9a5af2f9dc8f231f6ca20f61b95970380f1024e2 (diff) | |
download | qemu-f1a787b5f4b60524580ed9d1527568590d73789b.zip qemu-f1a787b5f4b60524580ed9d1527568590d73789b.tar.gz qemu-f1a787b5f4b60524580ed9d1527568590d73789b.tar.bz2 |
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 'docs/interop')
-rw-r--r-- | docs/interop/firmware.json | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/docs/interop/firmware.json b/docs/interop/firmware.json index 56814f0..cc8f869 100644 --- a/docs/interop/firmware.json +++ b/docs/interop/firmware.json @@ -258,7 +258,7 @@ # # @mode: Describes how the firmware build handles code versus variable # storage. If not present, it must be treated as if it was -# configured with value ``split``. Since: 7.0.0 +# configured with value @split. Since: 7.0.0 # # @executable: Identifies the firmware executable. The @mode # indicates whether there will be an associated @@ -267,13 +267,13 @@ # -drive if=none,id=pflash0,readonly=on,file=@executable.@filename,format=@executable.@format # -machine pflash0=pflash0 # or equivalent -blockdev instead of -drive. When -# @mode is ``combined`` the executable must be +# @mode is @combined the executable must be # cloned before use and configured with readonly=off. # With QEMU versions older than 4.0, you have to use # -drive if=pflash,unit=0,readonly=on,file=@executable.@filename,format=@executable.@format # # @nvram-template: Identifies the NVRAM template compatible with -# @executable, when @mode is set to ``split``, +# @executable, when @mode is set to @split, # otherwise it should not be present. # Management software instantiates an # individual copy -- a specific NVRAM file -- from |