From nobody Fri May 17 03:54:44 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1689837501; cv=none; d=zohomail.com; s=zohoarc; b=T1719dYa6+2XwWV5IaIPb5yKcmf2zLwH1Xn0vzbmWzgFs7YvE4xZhOl26SlTgQiUZRd9EBj9YnDm9o3f3EBhABaEBUA1emLIcqIEO+ZXuAZfzdhVXWEZmVOsstXDLjNcFJIqlvrJkikhLY5E3djpWEmKHKrdMTFgQVZxwO/I3Zg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689837501; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=A3WNb5Y5mes3xNMT00lRJt/+3zF9YM9fuUJojah5pm8=; b=lJQfBKbZgbj1uBWdj/uvXUOySEXrQ6E/JTwTffky5zycI3JOcb2eMqxfgSfPZvOPWDC4E4RBuiX8IWgS/tIH/YiNLcEiu8ufNKk0h4pSMDBhe84HYnaH0teVKNC/rri4hLR7dQOLMx+DRDTq8jlaRH6Lh6Cp57K4RypSJcVv8Kw= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1689837501096531.7942170480023; Thu, 20 Jul 2023 00:18:21 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qMNti-0000nr-J8; Thu, 20 Jul 2023 03:16:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtZ-0000fV-PM for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:19 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtX-0007Uk-0a for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:17 -0400 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-83-pvpxTIREMHK1G7oqXVsCSw-1; Thu, 20 Jul 2023 03:16:12 -0400 Received: from smtp.corp.redhat.com (int-mx10.intmail.prod.int.rdu2.redhat.com [10.11.54.10]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id BD5F2936D2F; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1D1944CD0E3; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 07B8021E5A0D; Thu, 20 Jul 2023 09:16:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689837373; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=A3WNb5Y5mes3xNMT00lRJt/+3zF9YM9fuUJojah5pm8=; b=IwrRw/TjhlRkTIZrA0TrRDungPgCy79pV5Lh4NlXuwAnhQ38j5wYDFefn4JXhEcWElQpr9 Kn1g/2bmM1mFk2CyCbdh4+GBgsd18iZUTcudDlVctoDAb6mfbinysOOB9Nq3DRX1i5mEP8 uzfNpSX9M2HYmGfsXxAq1Y2nGQyfkR0= X-MC-Unique: pvpxTIREMHK1G7oqXVsCSw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, Vladimir Sementsov-Ogievskiy Subject: [PATCH 1/6] qapi/block-core: Tidy up BlockLatencyHistogramInfo documentation Date: Thu, 20 Jul 2023 09:16:04 +0200 Message-ID: <20230720071610.1096458-2-armbru@redhat.com> In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com> References: <20230720071610.1096458-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.10 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689837502778100013 Content-Type: text/plain; charset="utf-8" Documentation for member @bin comes out like list of io request counts corresponding to histogram intervals. len("bins") =3D len("boundaries") + 1 For the example above, "bins" may be something like [3, 1, 5, 2], and corresponding histogram looks like: Note how the equation and the sentence following it run together. Replace the equation: list of io request counts corresponding to histogram intervals, same number of elements as "boundaries". For the example above, "bins" may be something like [3, 1, 5, 2], and corresponding histogram looks like: Cc: Vladimir Sementsov-Ogievskiy Signed-off-by: Markus Armbruster --- qapi/block-core.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index 5dd5f7e4b0..6ca448b6e6 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -652,10 +652,9 @@ # 10), [10, 50), [50, 100), [100, +inf). # # @bins: list of io request counts corresponding to histogram -# intervals. -# len(@bins) =3D len(@boundaries) + 1 -# For the example above, @bins may be something like [3, 1, 5, 2], -# and corresponding histogram looks like: +# intervals, same number of elements as @boundaries. For the +# example above, @bins may be something like [3, 1, 5, 2], and +# corresponding histogram looks like: # # :: # --=20 2.41.0 From nobody Fri May 17 03:54:44 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1689837499; cv=none; d=zohomail.com; s=zohoarc; b=VP3BD4pkjPx8OJOpajr+plKOzEa+15f1WdvU/l/Kp2IdJtmZErnL0J/Snb5/JU462vAKT8Coi++yvD2PF+1l1utoaVRZ7s8S6p2SR8RpEPuJNT+Nfy2j21ZTr8zulYPqtbxK5dUXiiYD/ISCA0zD6sbNBUYSpxuR45jQ/0QgYaI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689837499; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=XpOJGuS1jqrtLNbih9X78d4vyNoiUN5qW48IyvM/zEU=; b=c6WGc4AZBZA8w1dAVJrs490gUATW1o6VNHF75WIbQfBN/Lt2bAA+UNirMQK9BPJcgQAjaERwcB0TgHkPEcz1z/QZXJ3CnF7S9QUTsWtI9rE0ZUsuDYCiTqE/JgEyBHOeTq/SVuHSoFI31q/g7dVjFlBWqj+pzyFjEDUNMIWsMIo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1689837499762537.1570695748784; Thu, 20 Jul 2023 00:18:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qMNti-0000nl-IY; Thu, 20 Jul 2023 03:16:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtZ-0000fW-Q1 for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:19 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtW-0007Uf-TJ for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:17 -0400 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-659-Fk8-xcGJNrKuQvlYC0KAUw-1; Thu, 20 Jul 2023 03:16:11 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3CAE287321E for ; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1D0E7492CAC for ; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 09B4121E5A0E; Thu, 20 Jul 2023 09:16:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689837373; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=XpOJGuS1jqrtLNbih9X78d4vyNoiUN5qW48IyvM/zEU=; b=RRLd8HOI0vGK/krk2KsWoONxsI/8v0uBsR3aMlzAi8kVXFy3VTLH8UBUzT3kzhLdlUZHiC Qv6/PYpBVEZKGpVu1LPIqYBJoc72+KtQXmcKwi+8aVD+iYODBhly/vP1P86cQaXhP5+OWE GLzFM/D469W/BKVKdIY/8KaaaZkcqf8= X-MC-Unique: Fk8-xcGJNrKuQvlYC0KAUw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com Subject: [PATCH 2/6] qapi/block: Tidy up block-latency-histogram-set documentation Date: Thu, 20 Jul 2023 09:16:05 +0200 Message-ID: <20230720071610.1096458-3-armbru@redhat.com> In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com> References: <20230720071610.1096458-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689837500517100003 Content-Type: text/plain; charset="utf-8" Examples come out like Example set new histograms for all io types with intervals [0, 10), [10, 50), [50, 100), [100, +inf): The sentence "set new histograms ..." starts with a lower case letter. Capitalize it. Same for the other examples. Signed-off-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qapi/block.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/qapi/block.json b/qapi/block.json index 0f25ce3961..535892fddc 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -547,7 +547,7 @@ # # Example: # -# set new histograms for all io types with intervals [0, 10), [10, +# Set new histograms for all io types with intervals [0, 10), [10, # 50), [50, 100), [100, +inf): # # -> { "execute": "block-latency-histogram-set", @@ -557,7 +557,7 @@ # # Example: # -# set new histogram only for write, other histograms will remain not +# Set new histogram only for write, other histograms will remain not # changed (or not created): # # -> { "execute": "block-latency-histogram-set", @@ -567,7 +567,7 @@ # # Example: # -# set new histograms with the following intervals: read, flush: [0, +# Set new histograms with the following intervals: read, flush: [0, # 10), [10, 50), [50, 100), [100, +inf) write: [0, 1000), [1000, # 5000), [5000, +inf) # @@ -579,7 +579,7 @@ # # Example: # -# remove all latency histograms: +# Remove all latency histograms: # # -> { "execute": "block-latency-histogram-set", # "arguments": { "id": "drive0" } } --=20 2.41.0 From nobody Fri May 17 03:54:44 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1689837463; cv=none; d=zohomail.com; s=zohoarc; b=KkATnMDIdtkVt8h6Pzbfi1DWjGm8Ffvb0qfDyMisZNAX2cbLux5hghCP1bBrqHfi0qPPsc/6vW0PZkD4f6snav/ZBSyQYKxFnAd36RPpr5w1WKYGJrRos7l8syUEEuV3XDl+Az7fiQRULJlhMbJXATd4W8VdIPUKvP4LiY5dmpA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689837463; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=HsStXBGR+GwNlUE6Jvk/wB6AT9iqtZY7NR1IvLjECoM=; b=YT867+HgSU+ZhRpTBu7ZCICCDki5sRaCmTxiG/6930a9L6rLvVP9ExkMqy3E6uR5qSG18oinHknuiXnFHkpD+ZyYw3XM/AhZpODmDp/h9JQRlUKgyzvK0yeMrdXZxIgm+uDfqpfLoGPFbBEdld/z5gnBI4yq54oEACNyVj37lwo= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1689837463581340.8112189752868; Thu, 20 Jul 2023 00:17:43 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qMNtk-0000rP-BN; Thu, 20 Jul 2023 03:16:28 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtY-0000fU-QA for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:17 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtW-0007Ue-Uf for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:16 -0400 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-648-5AYyQbKKM0ykwwIdWjAOWg-1; Thu, 20 Jul 2023 03:16:11 -0400 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 40F51800962 for ; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 20305F6CD5 for ; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 0BD5B21E5A0F; Thu, 20 Jul 2023 09:16:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689837373; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=HsStXBGR+GwNlUE6Jvk/wB6AT9iqtZY7NR1IvLjECoM=; b=hU+psbLz9qqF/Rh4pn22ElZI6JLD7BeVDr8M9bTH9fC/plhsjY7aTQhEUfHbOaxpk3q6sV pQtINKQjVns6Y4ZZ7aRsYpfMczFz8BUPh9UPo7vjDnK3omdlXkMMxlIFHT454T4ax6ndsA WSaxijvxG/0ZfUpuxD1DsVOx7xSzaEE= X-MC-Unique: 5AYyQbKKM0ykwwIdWjAOWg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com Subject: [PATCH 3/6] qapi/qdev: Tidy up device_add documentation Date: Thu, 20 Jul 2023 09:16:06 +0200 Message-ID: <20230720071610.1096458-4-armbru@redhat.com> In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com> References: <20230720071610.1096458-1-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.5 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; 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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689837464384100003 The notes section comes out like this: Notes Additional arguments depend on the type. 1. For detailed information about this command, please refer to the =E2=80=98docs/qdev-device-use.txt=E2=80=99 file. 2. It=E2=80=99s possible to list device properties by running QEMU with= the =E2=80=9C-device DEVICE,help=E2=80=9D command-line argument, where D= EVICE is the device=E2=80=99s name The first item isn't numbered. Fix that: 1. Additional arguments depend on the type. 2. For detailed information about this command, please refer to the =E2=80=98docs/qdev-device-use.txt=E2=80=99 file. 3. It=E2=80=99s possible to list device properties by running QEMU with= the =E2=80=9C-device DEVICE,help=E2=80=9D command-line argument, where D= EVICE is the device=E2=80=99s name Signed-off-by: Markus Armbruster Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qapi/qdev.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/qapi/qdev.json b/qapi/qdev.json index 2d73b27c2a..6bc5a733b8 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -53,12 +53,12 @@ # # Notes: # -# Additional arguments depend on the type. +# 1. Additional arguments depend on the type. # -# 1. For detailed information about this command, please refer to the +# 2. For detailed information about this command, please refer to the # 'docs/qdev-device-use.txt' file. # -# 2. It's possible to list device properties by running QEMU with the +# 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 # --=20 2.41.0 From nobody Fri May 17 03:54:44 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1689837490; cv=none; d=zohomail.com; s=zohoarc; b=jkdhDnIJx3F6SIrNqhsxVtM7Ds+PuC+nHF/R1ZPxkGGxfeAFVIAPixVI4kmPA2ObR1wrcG146ypxf9Q0QEoEAm9DXYUxYc0CN6V7D84Z6B2tu2kNaw4sumCF4cSu26p3QULFWlaUyDZTEjULHpwEnp4N0dCjG/yGybJkI5jtXFA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689837490; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=3XyL8DP+qz5RtdvWmX4o2RvvaG70DKmKG3Lom7YU9HI=; b=M8y7Ozw3lDCLcecZgsl6397zSFymoLZvbk2nzlHojPSutpawkAeDZlPV/UuLcwfBWFloqNrC5b3AnYZh8LCgqkkq/to81imfmtOZsB9HCA8/d191eDA9b7JVg7eInq2V5OaiNJt3mdfsdzilOS3W/+5gCPW5Cptd1gOZrl4KKK4= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1689837490086752.8988304586153; Thu, 20 Jul 2023 00:18:10 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qMNti-0000my-6a; Thu, 20 Jul 2023 03:16:26 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNta-0000fY-06 for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:19 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.133.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtY-0007V2-CR for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:17 -0400 Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-300-gpb3S9-wNzuU9lrlo_EIJw-1; Thu, 20 Jul 2023 03:16:11 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4063638008B8; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 131631121315; Thu, 20 Jul 2023 07:16:11 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 0DEF621D0B4E; Thu, 20 Jul 2023 09:16:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689837375; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=3XyL8DP+qz5RtdvWmX4o2RvvaG70DKmKG3Lom7YU9HI=; b=Aeps8eMT+0i/IGSNvDOBF5qVDXyQ8tmKY8l8NjNDILUB4seDb3ZYrW25SoO2mUcik1ryVp aVsv7aPVgFB3GhSaEMQR/mfJGxyBLAeG1Pa6i90gmRp/5wyFV8ES7wp7gTZ1mNFWLwfsMj c4vkUrmyaNowwzHFhWDEsIKXLYTSGFo= X-MC-Unique: gpb3S9-wNzuU9lrlo_EIJw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com, =?UTF-8?q?Alex=20Benn=C3=A9e?= Subject: [PATCH 4/6] qapi/trace: Tidy up trace-event-get-state, -set-state documentation Date: Thu, 20 Jul 2023 09:16:07 +0200 Message-ID: <20230720071610.1096458-5-armbru@redhat.com> In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com> References: <20230720071610.1096458-1-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; 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: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689837490650100002 trace-event-set-state's explanation of how events are selected is under "Features". Doesn't belong there. Simply delete it, as it feels redundant with documentation of member @name. trace-event-get-state's explanation is under "Returns". Tolerable, but similarly redundant. Delete it, too. Cc: Alex Benn=C3=A9e Signed-off-by: Markus Armbruster --- qapi/trace.json | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/qapi/trace.json b/qapi/trace.json index 39b752fc88..0819d93016 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -60,9 +60,6 @@ # # Returns: a list of @TraceEventInfo for the matching events # -# An event is returned if its name matches the @name pattern -# (There are no longer any per-vCPU events). -# # Since: 2.2 # # Example: @@ -90,10 +87,8 @@ # @vcpu: The vCPU to act upon (all by default; since 2.7). # # Features: -# @deprecated: Member @vcpu is deprecated, and always ignored. # -# An event is enabled if its name matches the @name pattern -# (There are no longer any per-vCPU events). +# @deprecated: Member @vcpu is deprecated, and always ignored. # # Since: 2.2 # --=20 2.41.0 From nobody Fri May 17 03:54:44 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1689837455; cv=none; d=zohomail.com; s=zohoarc; b=aVfakpZVYLhDcvW3ulbe5dudZxVeXR8mMMLdLQE2gxc/21cllvbXon919W0+dN182ul04vXV0oNv3pNCxYvyigwpodmQhK39fduTH0LkWQLUQkFnXr+jJdD5vUzOEBl9AROaRNSW1SA8U5vQyVkYXYW9PlrzEiv4CQ/AWFvmyrg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689837455; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=8+zDVhz17FMSRUuB0yJ7Lf1+9BARA57sUzbFm5cNQUk=; b=i2o3D9dkRzcFjkNp3vgMwZnXNl1VhBwfG8DUZDMnV3CI/v3hUjD51nugUjYLOI5mYMvS1LHVBVyG0Is7nhucuPggVfYQiMF+YQx2sy2qIPn6uWB45f9nyIfroI5aMSyswvqmAU4FBFNnMzge9VluUMwILT9naPlg2RcKACuezLE= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 168983745539615.990403150097336; Thu, 20 Jul 2023 00:17:35 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qMNtk-0000tH-HA; Thu, 20 Jul 2023 03:16:28 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtZ-0000fX-QJ for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:19 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtX-0007Uo-0l for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:17 -0400 Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-643-U7QH5KG6Mb-zWxjRvawVBA-1; Thu, 20 Jul 2023 03:16:12 -0400 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 4C7F42800E81 for ; Thu, 20 Jul 2023 07:16:12 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 2725F492B02 for ; Thu, 20 Jul 2023 07:16:12 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 0FF4E21BA8DD; Thu, 20 Jul 2023 09:16:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689837374; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=8+zDVhz17FMSRUuB0yJ7Lf1+9BARA57sUzbFm5cNQUk=; b=XYcqRa4wJs2nWlrGVEOShXgI4HyYniiXcwSVYYISOnK7N5hCGs3TvgtQd/4blBsXqcs5Je AkQpRjPbkHIzG6n/uc6+KPSIMfuflBGLdwvl16ckEPCmvzMAXXD11HcCIa3W++5eslj819 nAUsns+7dbocYrH+oDNGXBwCFs8mFag= X-MC-Unique: U7QH5KG6Mb-zWxjRvawVBA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com Subject: [PATCH 5/6] qapi: Correct "eg." to "e.g." in documentation Date: Thu, 20 Jul 2023 09:16:08 +0200 Message-ID: <20230720071610.1096458-6-armbru@redhat.com> In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com> References: <20230720071610.1096458-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.9 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689837456285100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: Markus Armbruster --- qapi/char.json | 2 +- qapi/misc.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/qapi/char.json b/qapi/char.json index e413ac2b70..52aaff25eb 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -18,7 +18,7 @@ # @filename: the filename of the character device # # @frontend-open: shows whether the frontend device attached to this -# backend (eg. with the chardev=3D... option) is in open or closed +# backend (e.g. with the chardev=3D... option) is in open or closed # state (since 2.1) # # Notes: @filename is encoded using the QEMU command line character diff --git a/qapi/misc.json b/qapi/misc.json index ff070ec828..cda2effa81 100644 --- a/qapi/misc.json +++ b/qapi/misc.json @@ -18,7 +18,7 @@ # fail and the FD will be closed. # # @protocol: protocol name. Valid names are "vnc", "spice", -# "@dbus-display" or the name of a character device (eg. from +# "@dbus-display" or the name of a character device (e.g. from # -chardev id=3DXXXX) # # @fdname: file descriptor name previously passed via 'getfd' command --=20 2.41.0 From nobody Fri May 17 03:54:44 2024 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1689837496; cv=none; d=zohomail.com; s=zohoarc; b=n6hzkfr2W7hW40n14C4SZ7FZxFx9+WD3A98I2/yXwPi8jrMgbYsUIRjPy9FeJ/W4Xgo9OZemzceJtGTI7JTxDt8kc0XSq5o2WCMISc6iv++xRT5a1RczJfUwqbNNJsFYMl7jePw8g1BIWWMN/EnLg+4nLL6BNA0vULG6BLNxdpY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1689837496; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:To; bh=UiP4VeNpWkM6p57cmoTTy63aLXULsis86GnsQEorFNY=; b=WGID7bkxDoNWf5RhQGH/tbS7mwMRbrJjY/CZi6uNKwFS7D2CHJTrvfMwzMpg9WrkQdaUFohvrt4+6GlRbyFZhixtGaq3gXuAOjKD3sWPtjCLSj5ZPUaATcUp1Q2x97GHsGgWgFCrYChlovJNoTMJ0kFFDhrrftN3fiiSHbKk2NI= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1689837496508935.4474208149184; Thu, 20 Jul 2023 00:18:16 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qMNtm-0000vm-CA; Thu, 20 Jul 2023 03:16:30 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtb-0000fc-KQ for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:21 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1qMNtX-0007Ut-1m for qemu-devel@nongnu.org; Thu, 20 Jul 2023 03:16:18 -0400 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-647-HUy6D6lnMLCUNNmi6VDYvg-1; Thu, 20 Jul 2023 03:16:12 -0400 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id 7F955936D30 for ; Thu, 20 Jul 2023 07:16:12 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.37]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 27A291121314 for ; Thu, 20 Jul 2023 07:16:12 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 124F821BA5D5; Thu, 20 Jul 2023 09:16:10 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1689837374; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=UiP4VeNpWkM6p57cmoTTy63aLXULsis86GnsQEorFNY=; b=BK7xi0tfz18JQxms+bQ/CgwrjYwup2/9wRhoKrQD4kmovkt0ObiS4o9a4Bi9PYWecvT+v5 U4gxPVRi/Eit/LZZB9LyoEHEDu/tNQsgOHS0BmFM6H8iw9B90jV3wIE2Ek4/w2mY9VLe71 dbk+Bag16SduPRsql9O+s91kLN34TvI= X-MC-Unique: HUy6D6lnMLCUNNmi6VDYvg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eblake@redhat.com Subject: [PATCH 6/6] qapi: Reformat recent doc comments to conform to current conventions Date: Thu, 20 Jul 2023 09:16:09 +0200 Message-ID: <20230720071610.1096458-7-armbru@redhat.com> In-Reply-To: <20230720071610.1096458-1-armbru@redhat.com> References: <20230720071610.1096458-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.1 on 10.11.54.3 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.001, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 autolearn=ham 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1689837498777100001 Content-Type: text/plain; charset="utf-8" Since commit a937b6aa739 (qapi: Reformat doc comments to conform to current conventions), a number of comments not conforming to the current formatting conventions were added. No problem, just sweep the entire documentation once more. To check the generated documentation does not change, I compared the generated HTML before and after this commit with "wdiff -3". Finds no differences. Comparing with diff is not useful, as the reflown paragraphs are visible there. Signed-off-by: Markus Armbruster --- qapi/block-core.json | 78 +++++++++++++++++++--------------------- qapi/block.json | 4 +-- qapi/cxl.json | 4 +-- qapi/machine-target.json | 2 +- qapi/migration.json | 10 +++--- qapi/net.json | 1 - qapi/qom.json | 9 ++--- qapi/trace.json | 2 ++ qapi/ui.json | 2 +- 9 files changed, 55 insertions(+), 57 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index 6ca448b6e6..31c4812b44 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -136,7 +136,7 @@ # # @filename: Name of the extent file # -# @format: Extent type (e.g. FLAT or SPARSE) +# @format: Extent type (e.g. FLAT or SPARSE) # # @virtual-size: Number of bytes covered by this extent # @@ -853,9 +853,8 @@ # @min_wr_latency_ns: Minimum latency of write operations in the # defined interval, in nanoseconds. # -# @min_zone_append_latency_ns: Minimum latency of zone append operations -# in the defined interval, in nanoseconds -# (since 8.1) +# @min_zone_append_latency_ns: Minimum latency of zone append +# operations in the defined interval, in nanoseconds (since 8.1) # # @min_flush_latency_ns: Minimum latency of flush operations in the # defined interval, in nanoseconds. @@ -866,9 +865,8 @@ # @max_wr_latency_ns: Maximum latency of write operations in the # defined interval, in nanoseconds. # -# @max_zone_append_latency_ns: Maximum latency of zone append operations -# in the defined interval, in nanoseconds -# (since 8.1) +# @max_zone_append_latency_ns: Maximum latency of zone append +# operations in the defined interval, in nanoseconds (since 8.1) # # @max_flush_latency_ns: Maximum latency of flush operations in the # defined interval, in nanoseconds. @@ -879,9 +877,8 @@ # @avg_wr_latency_ns: Average latency of write operations in the # defined interval, in nanoseconds. # -# @avg_zone_append_latency_ns: Average latency of zone append operations -# in the defined interval, in nanoseconds -# (since 8.1) +# @avg_zone_append_latency_ns: Average latency of zone append +# operations in the defined interval, in nanoseconds (since 8.1) # # @avg_flush_latency_ns: Average latency of flush operations in the # defined interval, in nanoseconds. @@ -893,8 +890,7 @@ # the defined interval. # # @avg_zone_append_queue_depth: Average number of pending zone append -# operations in the defined interval -# (since 8.1). +# operations in the defined interval (since 8.1). # # Since: 2.5 ## @@ -919,8 +915,8 @@ # # @wr_bytes: The number of bytes written by the device. # -# @zone_append_bytes: The number of bytes appended by the zoned devices -# (since 8.1) +# @zone_append_bytes: The number of bytes appended by the zoned +# devices (since 8.1) # # @unmap_bytes: The number of bytes unmapped by the device (Since 4.2) # @@ -930,8 +926,8 @@ # @wr_operations: The number of write operations performed by the # device. # -# @zone_append_operations: The number of zone append operations performed -# by the zoned devices (since 8.1) +# @zone_append_operations: The number of zone append operations +# performed by the zoned devices (since 8.1) # # @flush_operations: The number of cache flush operations performed by # the device (since 0.15) @@ -946,7 +942,7 @@ # 0.15). # # @zone_append_total_time_ns: Total time spent on zone append writes -# in nanoseconds (since 8.1) +# in nanoseconds (since 8.1) # # @flush_total_time_ns: Total time spent on cache flushes in # nanoseconds (since 0.15). @@ -965,8 +961,8 @@ # @wr_merged: Number of write requests that have been merged into # another request (Since 2.3). # -# @zone_append_merged: Number of zone append requests that have been merged -# into another request (since 8.1) +# @zone_append_merged: Number of zone append requests that have been +# merged into another request (since 8.1) # # @unmap_merged: Number of unmap requests that have been merged into # another request (Since 4.2) @@ -981,9 +977,8 @@ # @failed_wr_operations: The number of failed write operations # performed by the device (Since 2.5) # -# @failed_zone_append_operations: The number of failed zone append write -# operations performed by the zoned devices -# (since 8.1) +# @failed_zone_append_operations: The number of failed zone append +# write operations performed by the zoned devices (since 8.1) # # @failed_flush_operations: The number of failed flush operations # performed by the device (Since 2.5) @@ -997,8 +992,8 @@ # @invalid_wr_operations: The number of invalid write operations # performed by the device (Since 2.5) # -# @invalid_zone_append_operations: The number of invalid zone append opera= tions -# performed by the zoned device (since 8.= 1) +# @invalid_zone_append_operations: The number of invalid zone append +# operations performed by the zoned device (since 8.1) # # @invalid_flush_operations: The number of invalid flush operations # performed by the device (Since 2.5) @@ -1019,7 +1014,8 @@ # # @wr_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) # -# @zone_append_latency_histogram: @BlockLatencyHistogramInfo. (since 8.1) +# @zone_append_latency_histogram: @BlockLatencyHistogramInfo. +# (since 8.1) # # @flush_latency_histogram: @BlockLatencyHistogramInfo. (Since 4.0) # @@ -1126,7 +1122,7 @@ # # @parent: This describes the file block device if it has one. # Contains recursively the statistics of the underlying protocol -# (e.g. the host file for a qcow2 image). If there is no +# (e.g. the host file for a qcow2 image). If there is no # underlying protocol, this field is omitted # # @backing: This describes the backing block device if it has one. @@ -1486,7 +1482,7 @@ # @format: the format of the overlay image, default is 'qcow2'. # # @mode: whether and how QEMU should create a new image, default is -# 'absolute-paths'. +# 'absolute-paths'. ## { 'struct': 'BlockdevSnapshotSync', 'data': { '*device': 'str', '*node-name': 'str', @@ -1550,7 +1546,7 @@ # # @bitmap: The name of a dirty bitmap to use. Must be present if sync # is "bitmap" or "incremental". Can be present if sync is "full" -# or "top". Must not be present otherwise. +# or "top". Must not be present otherwise. # (Since 2.4 (drive-backup), 3.1 (blockdev-backup)) # # @bitmap-mode: Specifies the type of data the bitmap should contain @@ -3477,16 +3473,16 @@ # @pass-discard-other: whether discard requests for the data source # should be issued on other occasions where a cluster gets freed # -# @discard-no-unref: when enabled, discards from the guest will not cause -# cluster allocations to be relinquished. This prevents qcow2 fragment= ation -# that would be caused by such discards. Besides potential -# performance degradation, such fragmentation can lead to increased -# allocation of clusters past the end of the image file, -# resulting in image files whose file length can grow much larger -# than their guest disk size would suggest. -# If image file length is of concern (e.g. when storing qcow2 -# images directly on block devices), you should consider enabling -# this option. (since 8.1) +# @discard-no-unref: when enabled, discards from the guest will not +# cause cluster allocations to be relinquished. This prevents +# qcow2 fragmentation that would be caused by such discards. +# Besides potential performance degradation, such fragmentation +# can lead to increased allocation of clusters past the end of the +# image file, resulting in image files whose file length can grow +# much larger than their guest disk size would suggest. If image +# file length is of concern (e.g. when storing qcow2 images +# directly on block devices), you should consider enabling this +# option. (since 8.1) # # @overlap-check: which overlap checks to perform for writes to the # image, defaults to 'cached' (since 2.2) @@ -5240,9 +5236,9 @@ # # @subformat: vhdx subformat (default: dynamic) # -# @block-state-zero: Force use of payload blocks of type -# 'ZERO'. Non-standard, but default. Do not set to 'off' when -# using 'qemu-img convert' with subformat=3Ddynamic. +# @block-state-zero: Force use of payload blocks of type 'ZERO'. +# Non-standard, but default. Do not set to 'off' when using +# 'qemu-img convert' with subformat=3Ddynamic. # # Since: 2.12 ## diff --git a/qapi/block.json b/qapi/block.json index 535892fddc..998008cfa8 100644 --- a/qapi/block.json +++ b/qapi/block.json @@ -534,8 +534,8 @@ # @boundaries-write: list of interval boundary values for write # latency histogram. # -# @boundaries-zap: list of interval boundary values for zone append write -# latency histogram. +# @boundaries-zap: list of interval boundary values for zone append +# write latency histogram. # # @boundaries-flush: list of interval boundary values for flush # latency histogram. diff --git a/qapi/cxl.json b/qapi/cxl.json index d5b5293eb5..8cc4c72fa9 100644 --- a/qapi/cxl.json +++ b/qapi/cxl.json @@ -172,8 +172,8 @@ # # @temperature: Device temperature in degrees Celsius. # -# @dirty-shutdown-count: Number of times the device has been unable -# to determine whether data loss may have occurred. +# @dirty-shutdown-count: Number of times the device has been unable to +# determine whether data loss may have occurred. # # @corrected-volatile-error-count: Total number of correctable errors # in volatile memory. diff --git a/qapi/machine-target.json b/qapi/machine-target.json index 3362f8dc3f..f0a6b72414 100644 --- a/qapi/machine-target.json +++ b/qapi/machine-target.json @@ -61,7 +61,7 @@ # @CpuModelCompareResult: # # An enumeration of CPU model comparison results. The result is -# usually calculated using e.g. CPU features or CPU generations. +# usually calculated using e.g. CPU features or CPU generations. # # @incompatible: If model A is incompatible to model B, model A is not # guaranteed to run where model B runs and the other way around. diff --git a/qapi/migration.json b/qapi/migration.json index 47dfef0278..5fb4494e22 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -465,8 +465,8 @@ # block devices (and thus take locks) immediately at the end of # migration. (since 3.0) # -# @x-ignore-shared: If enabled, QEMU will not migrate shared memory that is -# accessible on the destination machine. (since 4.0) +# @x-ignore-shared: If enabled, QEMU will not migrate shared memory +# that is accessible on the destination machine. (since 4.0) # # @validate-uuid: Send the UUID of the source to allow the destination # to ensure it is the same. (since 4.2) @@ -490,9 +490,9 @@ # @switchover-ack: If enabled, migration will not stop the source VM # and complete the migration until an ACK is received from the # destination that it's OK to do so. Exactly when this ACK is -# sent depends on the migrated devices that use this feature. -# For example, a device can use it to make sure some of its data -# is sent and loaded in the destination before doing switchover. +# sent depends on the migrated devices that use this feature. For +# example, a device can use it to make sure some of its data is +# sent and loaded in the destination before doing switchover. # This can reduce downtime if devices that support this capability # are present. 'return-path' capability must be enabled to use # it. (since 8.1) diff --git a/qapi/net.json b/qapi/net.json index db67501308..313c8a606e 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -663,7 +663,6 @@ # @type: Specify the driver used for interpreting remaining arguments. # # Since: 1.2 -# ## { 'union': 'Netdev', 'base': { 'id': 'str', 'type': 'NetClientDriver' }, diff --git a/qapi/qom.json b/qapi/qom.json index 7f92ea43e8..fa3e88c8e6 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -647,9 +647,10 @@ # selects a default alignment (currently the page size). # (default: 0) # -# @offset: the offset into the target file that the region starts at. You -# can use this option to back multiple regions with a single file. Must -# be a multiple of the page size. (default: 0) (since 8.1) +# @offset: the offset into the target file that the region starts at. +# You can use this option to back multiple regions with a single +# file. Must be a multiple of the page size. +# (default: 0) (since 8.1) # # @discard-data: if true, the file contents can be destroyed when QEMU # exits, to avoid unnecessarily flushing data to the backing file. @@ -662,7 +663,7 @@ # # @pmem: specifies whether the backing file specified by @mem-path is # in host persistent memory that can be accessed using the SNIA -# NVM programming model (e.g. Intel NVDIMM). +# NVM programming model (e.g. Intel NVDIMM). # # @readonly: if true, the backing file is opened read-only; if false, # it is opened read-write. (default: false) diff --git a/qapi/trace.json b/qapi/trace.json index 0819d93016..2077d7e117 100644 --- a/qapi/trace.json +++ b/qapi/trace.json @@ -38,6 +38,7 @@ # @vcpu: Whether this is a per-vCPU event (since 2.7). # # Features: +# # @deprecated: Member @vcpu is deprecated, and always ignored. # # Since: 2.2 @@ -56,6 +57,7 @@ # @vcpu: The vCPU to query (since 2.7). # # Features: +# # @deprecated: Member @vcpu is deprecated, and always ignored. # # Returns: a list of @TraceEventInfo for the matching events diff --git a/qapi/ui.json b/qapi/ui.json index bb06fb6039..006616aa77 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -1309,7 +1309,7 @@ # defaults to "off". (Since 3.1) # # @show-tabs: Display the tab bar for switching between the various -# graphical interfaces (e.g. VGA and virtual console character +# graphical interfaces (e.g. VGA and virtual console character # devices) by default. (Since 7.1) # # @show-menubar: Display the main window menubar. Defaults to "on". --=20 2.41.0