From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 2BB12C433EF for ; Tue, 3 May 2022 08:46:56 +0000 (UTC) Received: from localhost ([::1]:46510 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1nloBK-0007aR-Ku for qemu-devel@archiver.kernel.org; Tue, 03 May 2022 04:46:54 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:35524) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nlo5L-0004FX-Cs for qemu-devel@nongnu.org; Tue, 03 May 2022 04:40:43 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]:59303) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1nlo5I-00043m-V1 for qemu-devel@nongnu.org; Tue, 03 May 2022 04:40:43 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1651567240; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version:content-type:content-type: in-reply-to:in-reply-to:references:references; bh=T6H33zNQESuT/Lbmbuhsj0UHs4A8tUXHK9tmoqhSVFk=; b=VrSZbHicMm0wT1DXhHfn1kreY6N1itTxd3+5rJRPZNiIbMjdgmxJiuoZpnWwhUVjXeLtLm l1HyUtDjF6fxPNPrecFadyTHsGilLPmqDPGqEEYtMDW4vPc/DELaa1oa6SProBwuN0+8qI ApIY3hhJFDPJF7OPXw2pDHxmgme3aQM= Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-602-_jjBbX4VPjCC4suLxck7uQ-1; Tue, 03 May 2022 04:40:37 -0400 X-MC-Unique: _jjBbX4VPjCC4suLxck7uQ-1 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id E9E67801E67; Tue, 3 May 2022 08:40:36 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.36.112.3]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 96AC91537101; Tue, 3 May 2022 08:40:36 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 70EE121E68BC; Tue, 3 May 2022 10:40:35 +0200 (CEST) From: Markus Armbruster To: Andrea Bolognani Cc: qemu-devel@nongnu.org, Juan Quintela , Paolo Bonzini , Vladimir Sementsov-Ogievskiy , Eric Blake , "Dr. David Alan Gilbert" , Marcel Apfelbaum , qemu-block@nongnu.org, Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Eduardo Habkost , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Pavel Dovgalyuk , Yanan Wang , =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Gerd Hoffmann , John Snow Subject: Re: [PATCH v2 6/8] qapi: Drop unnecessary whitespace in comments References: <20220503073737.84223-1-abologna@redhat.com> <20220503073737.84223-7-abologna@redhat.com> Date: Tue, 03 May 2022 10:40:35 +0200 In-Reply-To: <20220503073737.84223-7-abologna@redhat.com> (Andrea Bolognani's message of "Tue, 3 May 2022 09:37:35 +0200") Message-ID: <87ilqndn5o.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/27.2 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 2.85 on 10.11.54.7 Received-SPF: pass client-ip=170.10.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -28 X-Spam_score: -2.9 X-Spam_bar: -- X-Spam_report: (-2.9 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.082, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_LOW=-0.7, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=unavailable autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org Sender: "Qemu-devel" Andrea Bolognani 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 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 > --- > 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 > ##