Skip to content

Commit

Permalink
qapi: Indent tagged doc comment sections properly
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Markus Armbruster committed Feb 12, 2024
1 parent d988487 commit 1ed1d4d
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 40 deletions.
46 changes: 23 additions & 23 deletions qapi/migration.json
Original file line number Diff line number Diff line change
Expand Up @@ -1699,24 +1699,24 @@
#
# Notes:
#
# 1. The 'query-migrate' command should be used to check migration's
# progress and final result (this information is provided by the
# 'status' member)
# 1. The 'query-migrate' command should be used to check
# migration's progress and final result (this information is
# 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
# not be used
# 3. The user Monitor's "detach" argument is invalid in QMP and
# should not be used
#
# 4. The uri argument should have the Uniform Resource Identifier of
# default destination VM. This connection will be bound to default
# network.
# 4. The uri argument should have the Uniform Resource Identifier
# of default destination VM. This connection will be bound to
# default network.
#
# 5. For now, number of migration streams is restricted to one, i.e
# number of items in 'channels' list is just 1.
# 5. For now, number of migration streams is restricted to one,
# i.e number of items in 'channels' list is just 1.
#
# 6. The 'uri' and 'channels' arguments are mutually exclusive;
# exactly one of the two should be present.
# 6. The 'uri' and 'channels' arguments are mutually exclusive;
# exactly one of the two should be present.
#
# Example:
#
Expand Down Expand Up @@ -1781,20 +1781,20 @@
#
# Notes:
#
# 1. It's a bad idea to use a string for the uri, but it needs
# to stay compatible with -incoming and the format of the uri
# is already exposed above libvirt.
# 1. It's a bad idea to use a string for the uri, but it needs to
# stay compatible with -incoming and the format of the uri is
# already exposed above libvirt.
#
# 2. QEMU must be started with -incoming defer to allow
# migrate-incoming to be used.
# 2. QEMU must be started with -incoming defer to allow
# 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
# number of items in 'channels' list is just 1.
# 5. For now, number of migration streams is restricted to one,
# i.e number of items in 'channels' list is just 1.
#
# 4. The 'uri' and 'channels' arguments are mutually exclusive;
# exactly one of the two should be present.
# 4. The 'uri' and 'channels' arguments are mutually exclusive;
# exactly one of the two should be present.
#
# Example:
#
Expand Down
12 changes: 7 additions & 5 deletions qapi/misc.json
Original file line number Diff line number Diff line change
Expand Up @@ -348,9 +348,10 @@
# - If file descriptor was not received, 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
#
Expand Down Expand Up @@ -379,10 +380,11 @@
#
# 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
# removed.
# If @fd is not specified, all file descriptors in @fdset-id will
# be removed.
#
# Example:
#
Expand Down
12 changes: 6 additions & 6 deletions qapi/qdev.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,14 +53,14 @@
#
# 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
# 'docs/qdev-device-use.txt' file.
# 2. For detailed information about this command, please refer to
# the 'docs/qdev-device-use.txt' file.
#
# 3. It's possible to list device properties by running QEMU with the
# "-device DEVICE,help" command-line argument, where DEVICE is the
# device's name
# 3. It's possible to list device properties by running QEMU with
# the "-device DEVICE,help" command-line argument, where DEVICE
# is the device's name
#
# Example:
#
Expand Down
10 changes: 5 additions & 5 deletions tests/qapi-schema/doc-good.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@
# @Base:
#
# @base1:
# description starts on a new line,
# not indented
# description starts on a new line,
# minimally indented
##
{ 'struct': 'Base', 'data': { 'base1': 'Enum' },
'if': { 'all': ['IFALL1', 'IFALL2'] } }
Expand Down Expand Up @@ -155,10 +155,10 @@
# TODO: frobnicate
# Notes:
#
# - Lorem ipsum dolor sit amet
# - Ut enim ad minim veniam
# - Lorem ipsum dolor sit amet
# - Ut enim ad minim veniam
#
# Duis aute irure dolor
# Duis aute irure dolor
# Example:
#
# -> in
Expand Down
2 changes: 1 addition & 1 deletion tests/qapi-schema/doc-good.out
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ doc symbol=Base

arg=base1
description starts on a new line,
not indented
minimally indented
doc symbol=Variant1
body=
A paragraph
Expand Down

0 comments on commit 1ed1d4d

Please sign in to comment.