Re: [PATCH v2 6/8] qapi: Drop unnecessary whitespace in comments

[Markus Armbruster]

Andrea Bolognani <abologna@redhat.com> writes:

> The only instances that get changed are those in which the
> additional whitespace was not (or couldn't possibly be) used for
> alignment purposes.
>
> Signed-off-by: Andrea Bolognani <abologna@redhat.com>

This mixes complete no-brainers with "I consider it an improvement, but
folks might disagree" (a few examples marked below for illustration).

Well, folks, if you disagree, speak up!  I don't:
Reviewed-by: Markus Armbruster <armbru@redhat.com>

> ---
>  qapi/block-core.json   | 24 ++++++++++++------------
>  qapi/block-export.json |  2 +-
>  qapi/block.json        |  2 +-
>  qapi/char.json         |  2 +-
>  qapi/dump.json         |  4 ++--
>  qapi/machine.json      |  8 ++++----
>  qapi/misc-target.json  |  6 +++---
>  qapi/misc.json         |  6 +++---
>  qapi/run-state.json    |  4 ++--
>  qapi/sockets.json      |  2 +-
>  qapi/ui.json           |  2 +-
>  11 files changed, 31 insertions(+), 31 deletions(-)
>
> diff --git a/qapi/block-core.json b/qapi/block-core.json
> index 2bce5bb0ae..e110af2f1d 100644
> --- a/qapi/block-core.json
> +++ b/qapi/block-core.json
> @@ -604,7 +604,7 @@
>  # @inserted: @BlockDeviceInfo describing the device if media is
>  #            present
>  #
> -# Since:  0.14
> +# Since: 0.14
>  ##
>  { 'struct': 'BlockInfo',
>    'data': {'device': 'str', '*qdev': 'str', 'type': 'str', 'removable': 
> 'bool',

Complete no-brainer.

> @@ -795,9 +795,9 @@
>  #
>  # Statistics of a virtual block device or a block backing device.
>  #
> -# @rd_bytes:      The number of bytes read by the device.
> +# @rd_bytes: The number of bytes read by the device.
>  #
> -# @wr_bytes:      The number of bytes written by the device.
> +# @wr_bytes: The number of bytes written by the device.
>  #
>  # @unmap_bytes: The number of bytes unmapped by the device (Since 4.2)
>  #

Almost a no-brainer.  Commit f11f57e405a added these two aligned with
@rd_operations and @wr_operations.  It also added unaligned ones.  Later
on, @unmap_bytes was inserted unaligned in between.

> @@ -970,7 +970,7 @@
>  # @qdev: The qdev ID, or if no ID is assigned, the QOM path of the block
>  #        device. (since 3.0)
>  #
> -# @stats:  A @BlockDeviceStats for the device.
> +# @stats: A @BlockDeviceStats for the device.
>  #
>  # @driver-specific: Optional driver-specific stats. (Since 4.2)
>  #
> @@ -1275,7 +1275,7 @@
>  #
>  # @node-name: graph node name to get the image resized (Since 2.0)
>  #
> -# @size:  new image size in bytes
> +# @size: new image size in bytes
>  #
>  # Returns: - nothing on success
>  #          - If @device is not a valid block device, DeviceNotFound
> @@ -1960,8 +1960,8 @@
>  # @job-id: identifier for the newly-created block job. If
>  #          omitted, the device name will be used. (Since 2.7)
>  #
> -# @device:  the device name or node-name of a root node whose writes should 
> be
> -#           mirrored.
> +# @device: the device name or node-name of a root node whose writes should be
> +#          mirrored.
>  #
>  # @target: the target of the new image. If the file exists, or if it
>  #          is a device, the existing file/device will be used as the new
> @@ -1981,7 +1981,7 @@
>  # @mode: whether and how QEMU should create a new image, default is
>  #        'absolute-paths'.
>  #
> -# @speed:  the maximum speed, in bytes per second
> +# @speed: the maximum speed, in bytes per second
>  #
>  # @sync: what parts of the disk image should be copied to the destination
>  #        (all the disk, only the sectors allocated in the topmost image, or
> @@ -2296,7 +2296,7 @@
>  #            broken Quorum files.  By default, @device is replaced, although
>  #            implicitly created filters on it are kept.
>  #
> -# @speed:  the maximum speed, in bytes per second
> +# @speed: the maximum speed, in bytes per second
>  #
>  # @sync: what parts of the disk image should be copied to the destination
>  #        (all the disk, only the sectors allocated in the topmost image, or
> @@ -4548,8 +4548,8 @@
>  ##
>  # @BlockdevQcow2Version:
>  #
> -# @v2:  The original QCOW2 format as introduced in qemu 0.10 (version 2)
> -# @v3:  The extended QCOW2 format as introduced in qemu 1.1 (version 3)
> +# @v2: The original QCOW2 format as introduced in qemu 0.10 (version 2)
> +# @v3: The extended QCOW2 format as introduced in qemu 1.1 (version 3)
>  #
>  # Since: 2.12
>  ##
> @@ -4905,7 +4905,7 @@
>  #
>  # Options for amending an image format
>  #
> -# @driver:          Block driver of the node to amend.
> +# @driver: Block driver of the node to amend.
>  #
>  # Since: 5.1
>  ##
> diff --git a/qapi/block-export.json b/qapi/block-export.json
> index 1de16d2589..53013b03ff 100644
> --- a/qapi/block-export.json
> +++ b/qapi/block-export.json
> @@ -387,7 +387,7 @@
>  #                 block-export-del command, but before the shutdown has
>  #                 completed)
>  #
> -# Since:  5.2
> +# Since: 5.2
>  ##
>  { 'struct': 'BlockExportInfo',
>    'data': { 'id': 'str',
> diff --git a/qapi/block.json b/qapi/block.json
> index 41b73c9934..96f557b3bb 100644
> --- a/qapi/block.json
> +++ b/qapi/block.json
> @@ -106,7 +106,7 @@
>  # Returns: - Nothing on success
>  #          - If @device is not a valid block device, DeviceNotFound
>  #
> -# Notes:    Ejecting a device with no media results in success
> +# Notes: Ejecting a device with no media results in success
>  #
>  # Since: 0.14
>  #
> diff --git a/qapi/char.json b/qapi/char.json
> index 8414ef2bc2..a40fe4b7bd 100644
> --- a/qapi/char.json
> +++ b/qapi/char.json
> @@ -216,7 +216,7 @@
>  #
>  # Configuration info for file chardevs.
>  #
> -# @in:  The name of the input file
> +# @in: The name of the input file
>  # @out: The name of the output file
>  # @append: Open the file in append mode (default false to
>  #          truncate) (Since 2.6)
> diff --git a/qapi/dump.json b/qapi/dump.json
> index 29441af9d8..90859c5483 100644
> --- a/qapi/dump.json
> +++ b/qapi/dump.json
> @@ -186,8 +186,8 @@
>  #
>  # Returns the available formats for dump-guest-memory
>  #
> -# Returns:  A @DumpGuestMemoryCapability object listing available formats for
> -#           dump-guest-memory
> +# Returns: A @DumpGuestMemoryCapability object listing available formats for
> +#          dump-guest-memory
>  #
>  # Since: 2.0
>  #
> diff --git a/qapi/machine.json b/qapi/machine.json
> index 9f91e46e8b..6c120eb1bb 100644
> --- a/qapi/machine.json
> +++ b/qapi/machine.json
> @@ -315,9 +315,9 @@
>  # query-current-machine), wake-up guest from suspend if the guest is
>  # in SUSPENDED state. Return an error otherwise.
>  #
> -# Since:  1.1
> +# Since: 1.1
>  #
> -# Returns:  nothing.
> +# Returns: nothing.
>  #
>  # Note: prior to 4.0, this command does nothing in case the guest
>  #       isn't suspended.
> @@ -368,9 +368,9 @@
>  # Injects a Non-Maskable Interrupt into the default CPU (x86/s390) or all 
> CPUs (ppc64).
>  # The command fails when the guest doesn't support injecting.
>  #
> -# Returns:  If successful, nothing
> +# Returns: If successful, nothing
>  #
> -# Since:  0.14
> +# Since: 0.14
>  #
>  # Note: prior to 2.1, this command was only supported for x86 and s390 VMs
>  #
> diff --git a/qapi/misc-target.json b/qapi/misc-target.json
> index 2fa68a6796..4944c0528f 100644
> --- a/qapi/misc-target.json
> +++ b/qapi/misc-target.json
> @@ -136,9 +136,9 @@
>  # The struct describes capability for a Secure Encrypted Virtualization
>  # feature.
>  #
> -# @pdh:  Platform Diffie-Hellman key (base64 encoded)
> +# @pdh: Platform Diffie-Hellman key (base64 encoded)
>  #
> -# @cert-chain:  PDH certificate chain (base64 encoded)
> +# @cert-chain: PDH certificate chain (base64 encoded)
>  #
>  # @cpu0-id: Unique ID of CPU0 (base64 encoded) (since 7.1)
>  #
> @@ -201,7 +201,7 @@
>  # The struct describes attestation report for a Secure Encrypted
>  # Virtualization feature.
>  #
> -# @data:  guest attestation report (base64 encoded)
> +# @data: guest attestation report (base64 encoded)
>  #
>  # Since: 6.1
>  ##
> diff --git a/qapi/misc.json b/qapi/misc.json
> index b83cc39029..6aec6bdbf3 100644
> --- a/qapi/misc.json
> +++ b/qapi/misc.json
> @@ -136,7 +136,7 @@
>  #
>  # Stop all guest VCPU execution.
>  #
> -# Since:  0.14
> +# Since: 0.14
>  #
>  # Notes: This function will succeed even if the guest is already in the 
> stopped
>  #        state.  In "inmigrate" state, it will ensure that the guest
> @@ -156,9 +156,9 @@
>  #
>  # Resume guest VCPU execution.
>  #
> -# Since:  0.14
> +# Since: 0.14
>  #
> -# Returns:  If successful, nothing
> +# Returns: If successful, nothing
>  #
>  # Notes: This command will succeed if the guest is currently running.  It
>  #        will also succeed if the guest is in the "inmigrate" state; in
> diff --git a/qapi/run-state.json b/qapi/run-state.json
> index 30a2f5231d..6e2162d7b3 100644
> --- a/qapi/run-state.json
> +++ b/qapi/run-state.json
> @@ -104,7 +104,7 @@
>  #
>  # @status: the virtual machine @RunState
>  #
> -# Since:  0.14
> +# Since: 0.14
>  #
>  # Notes: @singlestep is enabled through the GDB stub
>  ##
> @@ -118,7 +118,7 @@
>  #
>  # Returns: @StatusInfo reflecting all VCPUs
>  #
> -# Since:  0.14
> +# Since: 0.14
>  #
>  # Example:
>  #
> diff --git a/qapi/sockets.json b/qapi/sockets.json
> index fccc38584b..b4f84d3334 100644
> --- a/qapi/sockets.json
> +++ b/qapi/sockets.json
> @@ -189,7 +189,7 @@
>  # Captures the address of a socket, which could also be a named file
>  # descriptor
>  #
> -# @type:       Transport type
> +# @type: Transport type
>  #
>  # Since: 2.9
>  ##

Single member with the description aligned to tab stop in colunn 16.
Likely done this way to provide for adding more without rejiggering the
alignment.  Bah.

Improvement for me.

> diff --git a/qapi/ui.json b/qapi/ui.json
> index 9f19beea6d..c844237434 100644
> --- a/qapi/ui.json
> +++ b/qapi/ui.json
> @@ -1260,7 +1260,7 @@
>  #
>  # Curses display options.
>  #
> -# @charset:       Font charset used by guest (default: CP437).
> +# @charset: Font charset used by guest (default: CP437).
>  #
>  # Since: 4.0
>  ##