aboutsummaryrefslogtreecommitdiff
path: root/qapi/ui.json
diff options
context:
space:
mode:
authorJohn Snow <jsnow@redhat.com>2024-06-26 18:21:18 -0400
committerMarkus Armbruster <armbru@redhat.com>2024-07-06 08:58:24 +0200
commit543ff13a20663b9aa93a4531fc75a1ebe7c69269 (patch)
tree46dc77ff8ceca86b9ed30c5631a5c5953662f93a /qapi/ui.json
parent649c6fa4eec03667b29d52685d327c73a7e9a467 (diff)
qapi: add markup to note blocks
Generally, surround command-line options with ``literal`` markup to help it stand out from prose in rendered HTML, and add cross-references to replace "see also" messages. References to types, values, and other QAPI definitions are not yet adjusted here; they will be converted en masse in a subsequent patch after the new QAPI doc generator is merged. Signed-off-by: John Snow <jsnow@redhat.com> Reviewed-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240626222128.406106-13-jsnow@redhat.com> Signed-off-by: Markus Armbruster <armbru@redhat.com>
Diffstat (limited to 'qapi/ui.json')
-rw-r--r--qapi/ui.json2
1 files changed, 1 insertions, 1 deletions
diff --git a/qapi/ui.json b/qapi/ui.json
index a1999965e4..5bcccbfc93 100644
--- a/qapi/ui.json
+++ b/qapi/ui.json
@@ -1268,7 +1268,7 @@
# Since: 2.6
#
# .. note:: The consoles are visible in the qom tree, under
-# /backend/console[$index]. They have a device link and head
+# ``/backend/console[$index]``. They have a device link and head
# property, so it is possible to map which console belongs to which
# device and display.
#