qapi: Use proper markup instead of CAPS for emphasis in doc comments

Signed-off-by: Markus Armbruster <armbru@redhat.com>
Message-ID: <20250527073916.1243024-9-armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
This commit is contained in:
Markus Armbruster 2025-05-27 09:39:11 +02:00
parent 83691fa069
commit 188b31ad42
4 changed files with 19 additions and 19 deletions

View file

@ -1589,7 +1589,7 @@
#
# @bitmap-mode: Specifies the type of data the bitmap should contain
# after the operation concludes. Must be present if a bitmap was
# provided, must NOT be present otherwise. (Since 4.2)
# provided, must **not** be present otherwise. (Since 4.2)
#
# @compress: true to compress data, if the target format supports it.
# (default: false) (since 2.8)

View file

@ -54,9 +54,9 @@
# @paging: if true, do paging to get guest's memory mapping. This
# allows using gdb to process the core file.
#
# IMPORTANT: this option can make QEMU allocate several gigabytes
# of RAM. This can happen for a large guest, or a malicious guest
# pretending to be large.
# **Important**: this option can make QEMU allocate several
# gigabytes of RAM. This can happen for a large guest, or a
# malicious guest pretending to be large.
#
# Also, paging=true has the following limitations:
#

View file

@ -407,7 +407,7 @@
# @postcopy-ram: Start executing on the migration target before all of
# RAM has been migrated, pulling the remaining pages along as
# needed. The capacity must have the same setting on both source
# and target or migration will not even start. NOTE: If the
# and target or migration will not even start. **Note:** if the
# migration fails during postcopy the VM will fail. (since 2.6)
#
# @x-colo: If enabled, migration will never end, and the state of the
@ -801,10 +801,10 @@
# (Since 2.8)
#
# @avail-switchover-bandwidth: to set the available bandwidth that
# migration can use during switchover phase. NOTE! This does not
# limit the bandwidth during switchover, but only for calculations
# when making decisions to switchover. By default, this value is
# zero, which means QEMU will estimate the bandwidth
# migration can use during switchover phase. **Note:** this does
# not limit the bandwidth during switchover, but only for
# calculations when making decisions to switchover. By default,
# this value is zero, which means QEMU will estimate the bandwidth
# automatically. This can be set when the estimated value is not
# accurate, while the user is able to guarantee such bandwidth is
# available when switching over. When specified correctly, this
@ -982,10 +982,10 @@
# (Since 2.8)
#
# @avail-switchover-bandwidth: to set the available bandwidth that
# migration can use during switchover phase. NOTE! This does not
# limit the bandwidth during switchover, but only for calculations
# when making decisions to switchover. By default, this value is
# zero, which means QEMU will estimate the bandwidth
# migration can use during switchover phase. **Note:** this does
# not limit the bandwidth during switchover, but only for
# calculations when making decisions to switchover. By default,
# this value is zero, which means QEMU will estimate the bandwidth
# automatically. This can be set when the estimated value is not
# accurate, while the user is able to guarantee such bandwidth is
# available when switching over. When specified correctly, this
@ -1192,10 +1192,10 @@
# (Since 2.8)
#
# @avail-switchover-bandwidth: to set the available bandwidth that
# migration can use during switchover phase. NOTE! This does not
# limit the bandwidth during switchover, but only for calculations
# when making decisions to switchover. By default, this value is
# zero, which means QEMU will estimate the bandwidth
# migration can use during switchover phase. **Note:** this does
# not limit the bandwidth during switchover, but only for
# calculations when making decisions to switchover. By default,
# this value is zero, which means QEMU will estimate the bandwidth
# automatically. This can be set when the estimated value is not
# accurate, while the user is able to guarantee such bandwidth is
# available when switching over. When specified correctly, this

View file

@ -222,8 +222,8 @@
# .. note:: This command only exists as a stop-gap. Its use is highly
# discouraged. The semantics of this command are not guaranteed:
# this means that command names, arguments and responses can change
# or be removed at ANY time. Applications that rely on long term
# stability guarantees should NOT use this command.
# or be removed at **any** time. Applications that rely on long
# term stability guarantees should **not** use this command.
#
# Known limitations:
#