[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PULL 09/29] qapi: Fix doc comment indentation again
From: |
Markus Armbruster |
Subject: |
[PULL 09/29] qapi: Fix doc comment indentation again |
Date: |
Tue, 29 Sep 2020 22:19:06 +0200 |
From: Peter Maydell <peter.maydell@linaro.org>
In commit 26ec4e53f2 and similar commits we fixed the indentation
for doc comments in our qapi json files to follow a new stricter
standard for indentation, which permits only:
@arg: description line 1
description line 2
or:
@arg:
line 1
line 2
but because the script updates that enforce this are not yet in the
tree we have had a steady trickle of subsequent changes which didn't
follow the new rules.
Fix the latest round of mis-indented doc comments.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
Message-Id: <20200925162316.21205-2-peter.maydell@linaro.org>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Updated for commit 4c437254b807 and a83e24ba1a5]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/block-core.json | 4 +-
qapi/machine.json | 4 +-
qapi/migration.json | 108 +++++++++++++++++++++----------------------
3 files changed, 59 insertions(+), 57 deletions(-)
diff --git a/qapi/block-core.json b/qapi/block-core.json
index 3c16f1e11d..dd77a91174 100644
--- a/qapi/block-core.json
+++ b/qapi/block-core.json
@@ -4316,8 +4316,8 @@
# @data-file-raw: True if the external data file must stay valid as a
# standalone (read-only) raw image without looking at qcow2
# metadata (default: false; since: 4.0)
-# @extended-l2 True to make the image have extended L2 entries
-# (default: false; since 5.2)
+# @extended-l2: True to make the image have extended L2 entries
+# (default: false; since 5.2)
# @size: Size of the virtual disk in bytes
# @version: Compatibility level (default: v3)
# @backing-file: File name of the backing file if a backing file
diff --git a/qapi/machine.json b/qapi/machine.json
index c061cce0e4..2c237563ea 100644
--- a/qapi/machine.json
+++ b/qapi/machine.json
@@ -1001,9 +1001,11 @@
#
# Request the balloon driver to change its balloon size.
#
-# @value: the target logical size of the VM in bytes
+# @value: the target logical size of the VM in bytes.
# We can deduce the size of the balloon using this formula:
+#
# logical_vm_size = vm_ram_size - balloon_size
+#
# From it we have: balloon_size = vm_ram_size - @value
#
# Returns: - Nothing on success
diff --git a/qapi/migration.json b/qapi/migration.json
index ce2216cfea..7f5e6fd681 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -681,23 +681,23 @@
# Defaults to 1. (Since 5.0)
#
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
-# aliases for the purpose of dirty bitmap migration. Such
-# aliases may for example be the corresponding names on the
-# opposite site.
-# The mapping must be one-to-one, but not necessarily
-# complete: On the source, unmapped bitmaps and all bitmaps
-# on unmapped nodes will be ignored. On the destination,
-# encountering an unmapped alias in the incoming migration
-# stream will result in a report, and all further bitmap
-# migration data will then be discarded.
-# Note that the destination does not know about bitmaps it
-# does not receive, so there is no limitation or requirement
-# regarding the number of bitmaps received, or how they are
-# named, or on which nodes they are placed.
-# By default (when this parameter has never been set), bitmap
-# names are mapped to themselves. Nodes are mapped to their
-# block device name if there is one, and to their node name
-# otherwise. (Since 5.2)
+# aliases for the purpose of dirty bitmap migration.
Such
+# aliases may for example be the corresponding names on
the
+# opposite site.
+# The mapping must be one-to-one, but not necessarily
+# complete: On the source, unmapped bitmaps and all
bitmaps
+# on unmapped nodes will be ignored. On the
destination,
+# encountering an unmapped alias in the incoming
migration
+# stream will result in a report, and all further bitmap
+# migration data will then be discarded.
+# Note that the destination does not know about bitmaps
it
+# does not receive, so there is no limitation or
requirement
+# regarding the number of bitmaps received, or how they
are
+# named, or on which nodes they are placed.
+# By default (when this parameter has never been set),
bitmap
+# names are mapped to themselves. Nodes are mapped to
their
+# block device name if there is one, and to their node
name
+# otherwise. (Since 5.2)
#
# Since: 2.4
##
@@ -841,23 +841,23 @@
# Defaults to 1. (Since 5.0)
#
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
-# aliases for the purpose of dirty bitmap migration. Such
-# aliases may for example be the corresponding names on the
-# opposite site.
-# The mapping must be one-to-one, but not necessarily
-# complete: On the source, unmapped bitmaps and all bitmaps
-# on unmapped nodes will be ignored. On the destination,
-# encountering an unmapped alias in the incoming migration
-# stream will result in a report, and all further bitmap
-# migration data will then be discarded.
-# Note that the destination does not know about bitmaps it
-# does not receive, so there is no limitation or requirement
-# regarding the number of bitmaps received, or how they are
-# named, or on which nodes they are placed.
-# By default (when this parameter has never been set), bitmap
-# names are mapped to themselves. Nodes are mapped to their
-# block device name if there is one, and to their node name
-# otherwise. (Since 5.2)
+# aliases for the purpose of dirty bitmap migration.
Such
+# aliases may for example be the corresponding names on
the
+# opposite site.
+# The mapping must be one-to-one, but not necessarily
+# complete: On the source, unmapped bitmaps and all
bitmaps
+# on unmapped nodes will be ignored. On the
destination,
+# encountering an unmapped alias in the incoming
migration
+# stream will result in a report, and all further bitmap
+# migration data will then be discarded.
+# Note that the destination does not know about bitmaps
it
+# does not receive, so there is no limitation or
requirement
+# regarding the number of bitmaps received, or how they
are
+# named, or on which nodes they are placed.
+# By default (when this parameter has never been set),
bitmap
+# names are mapped to themselves. Nodes are mapped to
their
+# block device name if there is one, and to their node
name
+# otherwise. (Since 5.2)
#
# Since: 2.4
##
@@ -1037,23 +1037,23 @@
# Defaults to 1. (Since 5.0)
#
# @block-bitmap-mapping: Maps block nodes and bitmaps on them to
-# aliases for the purpose of dirty bitmap migration. Such
-# aliases may for example be the corresponding names on the
-# opposite site.
-# The mapping must be one-to-one, but not necessarily
-# complete: On the source, unmapped bitmaps and all bitmaps
-# on unmapped nodes will be ignored. On the destination,
-# encountering an unmapped alias in the incoming migration
-# stream will result in a report, and all further bitmap
-# migration data will then be discarded.
-# Note that the destination does not know about bitmaps it
-# does not receive, so there is no limitation or requirement
-# regarding the number of bitmaps received, or how they are
-# named, or on which nodes they are placed.
-# By default (when this parameter has never been set), bitmap
-# names are mapped to themselves. Nodes are mapped to their
-# block device name if there is one, and to their node name
-# otherwise. (Since 5.2)
+# aliases for the purpose of dirty bitmap migration.
Such
+# aliases may for example be the corresponding names on
the
+# opposite site.
+# The mapping must be one-to-one, but not necessarily
+# complete: On the source, unmapped bitmaps and all
bitmaps
+# on unmapped nodes will be ignored. On the
destination,
+# encountering an unmapped alias in the incoming
migration
+# stream will result in a report, and all further bitmap
+# migration data will then be discarded.
+# Note that the destination does not know about bitmaps
it
+# does not receive, so there is no limitation or
requirement
+# regarding the number of bitmaps received, or how they
are
+# named, or on which nodes they are placed.
+# By default (when this parameter has never been set),
bitmap
+# names are mapped to themselves. Nodes are mapped to
their
+# block device name if there is one, and to their node
name
+# otherwise. (Since 5.2)
#
# Since: 2.4
##
@@ -1744,9 +1744,9 @@
# Information about current dirty page rate of vm.
#
# @dirty-rate: @dirtyrate describing the dirty page rate of vm
-# in units of MB/s.
-# If this field returns '-1', it means querying has not
-# yet started or completed.
+# in units of MB/s.
+# If this field returns '-1', it means querying has not
+# yet started or completed.
#
# @status: status containing dirtyrate query status includes
# 'unstarted' or 'measuring' or 'measured'
--
2.26.2
- [PULL 00/29] QAPI patches patches for 2020-09-29, Markus Armbruster, 2020/09/29
- [PULL 01/29] qapi: Restrict LostTickPolicy enum to machine code, Markus Armbruster, 2020/09/29
- [PULL 19/29] qga/qapi-schema.json: Add some headings, Markus Armbruster, 2020/09/29
- [PULL 10/29] qapi/block.json: Add newline after "Example:" for block-latency-histogram-set, Markus Armbruster, 2020/09/29
- [PULL 04/29] qapi: Restrict query-vm-generation-id command to machine code, Markus Armbruster, 2020/09/29
- [PULL 07/29] qapi: Extract ACPI commands to 'acpi.json', Markus Armbruster, 2020/09/29
- [PULL 06/29] qapi: Restrict device memory commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 08/29] qapi: Extract PCI commands to 'pci.json', Markus Armbruster, 2020/09/29
- [PULL 11/29] tests/qapi/doc-good.json: Prepare for qapi-doc Sphinx extension, Markus Armbruster, 2020/09/29
- [PULL 03/29] qapi: Restrict balloon-related commands to machine code, Markus Armbruster, 2020/09/29
- [PULL 09/29] qapi: Fix doc comment indentation again,
Markus Armbruster <=
- [PULL 27/29] Remove Texinfo related line from git.orderfile, Markus Armbruster, 2020/09/29
- [PULL 20/29] tests/qapi-schema: Convert doc-good.json to rST-style strong/emphasis, Markus Armbruster, 2020/09/29
- [PULL 29/29] Remove texinfo dependency from docker and CI configs, Markus Armbruster, 2020/09/29
- [PULL 21/29] meson.build: Move SPHINX_ARGS to top level meson.build file, Markus Armbruster, 2020/09/29
- [PULL 16/29] docs/interop: Convert qemu-ga-ref to rST, Markus Armbruster, 2020/09/29
- [PULL 26/29] scripts/texi2pod: Delete unused script, Markus Armbruster, 2020/09/29
- [PULL 28/29] configure: Drop texinfo requirement, Markus Armbruster, 2020/09/29
- [PULL 23/29] tests/qapi-schema: Add test of the rST QAPI doc-comment output, Markus Armbruster, 2020/09/29
- [PULL 17/29] docs/interop: Convert qemu-qmp-ref to rST, Markus Armbruster, 2020/09/29
- [PULL 24/29] scripts/qapi: Remove texinfo generation support, Markus Armbruster, 2020/09/29