mirror of
https://github.com/Motorhead1991/qemu.git
synced 2025-08-11 03:24:58 -06:00
qapi: Indent tagged doc comment sections properly
docs/devel/qapi-code-gen demands that the "second and subsequent lines of sections other than "Example"/"Examples" should be indented". Commit a937b6aa739q (qapi: Reformat doc comments to conform to current conventions) missed a few instances, and messed up a few others. Clean that up. Signed-off-by: Markus Armbruster <armbru@redhat.com> Message-ID: <20240205074709.3613229-5-armbru@redhat.com> Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
parent
d988487882
commit
1ed1d4d608
5 changed files with 42 additions and 40 deletions
|
@ -1699,24 +1699,24 @@
|
||||||
#
|
#
|
||||||
# Notes:
|
# Notes:
|
||||||
#
|
#
|
||||||
# 1. The 'query-migrate' command should be used to check migration's
|
# 1. The 'query-migrate' command should be used to check
|
||||||
# progress and final result (this information is provided by the
|
# migration's progress and final result (this information is
|
||||||
# 'status' member)
|
# provided by the 'status' member)
|
||||||
#
|
#
|
||||||
# 2. All boolean arguments default to false
|
# 2. All boolean arguments default to false
|
||||||
#
|
#
|
||||||
# 3. The user Monitor's "detach" argument is invalid in QMP and should
|
# 3. The user Monitor's "detach" argument is invalid in QMP and
|
||||||
# not be used
|
# should not be used
|
||||||
#
|
#
|
||||||
# 4. The uri argument should have the Uniform Resource Identifier of
|
# 4. The uri argument should have the Uniform Resource Identifier
|
||||||
# default destination VM. This connection will be bound to default
|
# of default destination VM. This connection will be bound to
|
||||||
# network.
|
# default network.
|
||||||
#
|
#
|
||||||
# 5. For now, number of migration streams is restricted to one, i.e
|
# 5. For now, number of migration streams is restricted to one,
|
||||||
# number of items in 'channels' list is just 1.
|
# i.e number of items in 'channels' list is just 1.
|
||||||
#
|
#
|
||||||
# 6. The 'uri' and 'channels' arguments are mutually exclusive;
|
# 6. The 'uri' and 'channels' arguments are mutually exclusive;
|
||||||
# exactly one of the two should be present.
|
# exactly one of the two should be present.
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
#
|
#
|
||||||
|
@ -1781,20 +1781,20 @@
|
||||||
#
|
#
|
||||||
# Notes:
|
# Notes:
|
||||||
#
|
#
|
||||||
# 1. It's a bad idea to use a string for the uri, but it needs
|
# 1. It's a bad idea to use a string for the uri, but it needs to
|
||||||
# to stay compatible with -incoming and the format of the uri
|
# stay compatible with -incoming and the format of the uri is
|
||||||
# is already exposed above libvirt.
|
# already exposed above libvirt.
|
||||||
#
|
#
|
||||||
# 2. QEMU must be started with -incoming defer to allow
|
# 2. QEMU must be started with -incoming defer to allow
|
||||||
# migrate-incoming to be used.
|
# migrate-incoming to be used.
|
||||||
#
|
#
|
||||||
# 3. The uri format is the same as for -incoming
|
# 3. The uri format is the same as for -incoming
|
||||||
#
|
#
|
||||||
# 5. For now, number of migration streams is restricted to one, i.e
|
# 5. For now, number of migration streams is restricted to one,
|
||||||
# number of items in 'channels' list is just 1.
|
# i.e number of items in 'channels' list is just 1.
|
||||||
#
|
#
|
||||||
# 4. The 'uri' and 'channels' arguments are mutually exclusive;
|
# 4. The 'uri' and 'channels' arguments are mutually exclusive;
|
||||||
# exactly one of the two should be present.
|
# exactly one of the two should be present.
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
#
|
#
|
||||||
|
|
|
@ -348,9 +348,10 @@
|
||||||
# - If file descriptor was not received, GenericError
|
# - If file descriptor was not received, GenericError
|
||||||
# - If @fdset-id is a negative value, GenericError
|
# - If @fdset-id is a negative value, GenericError
|
||||||
#
|
#
|
||||||
# Notes: The list of fd sets is shared by all monitor connections.
|
# Notes:
|
||||||
|
# The list of fd sets is shared by all monitor connections.
|
||||||
#
|
#
|
||||||
# If @fdset-id is not specified, a new fd set will be created.
|
# If @fdset-id is not specified, a new fd set will be created.
|
||||||
#
|
#
|
||||||
# Since: 1.2
|
# Since: 1.2
|
||||||
#
|
#
|
||||||
|
@ -379,10 +380,11 @@
|
||||||
#
|
#
|
||||||
# Since: 1.2
|
# Since: 1.2
|
||||||
#
|
#
|
||||||
# Notes: The list of fd sets is shared by all monitor connections.
|
# Notes:
|
||||||
|
# The list of fd sets is shared by all monitor connections.
|
||||||
#
|
#
|
||||||
# If @fd is not specified, all file descriptors in @fdset-id will be
|
# If @fd is not specified, all file descriptors in @fdset-id will
|
||||||
# removed.
|
# be removed.
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
#
|
#
|
||||||
|
|
|
@ -53,14 +53,14 @@
|
||||||
#
|
#
|
||||||
# Notes:
|
# Notes:
|
||||||
#
|
#
|
||||||
# 1. Additional arguments depend on the type.
|
# 1. Additional arguments depend on the type.
|
||||||
#
|
#
|
||||||
# 2. For detailed information about this command, please refer to the
|
# 2. For detailed information about this command, please refer to
|
||||||
# 'docs/qdev-device-use.txt' file.
|
# the 'docs/qdev-device-use.txt' file.
|
||||||
#
|
#
|
||||||
# 3. It's possible to list device properties by running QEMU with the
|
# 3. It's possible to list device properties by running QEMU with
|
||||||
# "-device DEVICE,help" command-line argument, where DEVICE is the
|
# the "-device DEVICE,help" command-line argument, where DEVICE
|
||||||
# device's name
|
# is the device's name
|
||||||
#
|
#
|
||||||
# Example:
|
# Example:
|
||||||
#
|
#
|
||||||
|
|
|
@ -73,8 +73,8 @@
|
||||||
# @Base:
|
# @Base:
|
||||||
#
|
#
|
||||||
# @base1:
|
# @base1:
|
||||||
# description starts on a new line,
|
# description starts on a new line,
|
||||||
# not indented
|
# minimally indented
|
||||||
##
|
##
|
||||||
{ 'struct': 'Base', 'data': { 'base1': 'Enum' },
|
{ 'struct': 'Base', 'data': { 'base1': 'Enum' },
|
||||||
'if': { 'all': ['IFALL1', 'IFALL2'] } }
|
'if': { 'all': ['IFALL1', 'IFALL2'] } }
|
||||||
|
@ -155,10 +155,10 @@
|
||||||
# TODO: frobnicate
|
# TODO: frobnicate
|
||||||
# Notes:
|
# Notes:
|
||||||
#
|
#
|
||||||
# - Lorem ipsum dolor sit amet
|
# - Lorem ipsum dolor sit amet
|
||||||
# - Ut enim ad minim veniam
|
# - Ut enim ad minim veniam
|
||||||
#
|
#
|
||||||
# Duis aute irure dolor
|
# Duis aute irure dolor
|
||||||
# Example:
|
# Example:
|
||||||
#
|
#
|
||||||
# -> in
|
# -> in
|
||||||
|
|
|
@ -118,7 +118,7 @@ doc symbol=Base
|
||||||
|
|
||||||
arg=base1
|
arg=base1
|
||||||
description starts on a new line,
|
description starts on a new line,
|
||||||
not indented
|
minimally indented
|
||||||
doc symbol=Variant1
|
doc symbol=Variant1
|
||||||
body=
|
body=
|
||||||
A paragraph
|
A paragraph
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue