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 lists1p.gnu.org (lists1p.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 7E006C982E6 for ; Mon, 21 Sep 2026 20:58:07 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists1p.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1x8l58-0005Of-RO; Mon, 21 Sep 2026 16:57:47 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists1p.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1x8l55-0005N0-KR for qemu-devel@nongnu.org; Mon, 21 Sep 2026 16:57:43 -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 1x8l53-0003Zr-IL for qemu-devel@nongnu.org; Mon, 21 Sep 2026 16:57:43 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1790024261; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=akpMxJqY/YX3lbLfFuudMfj4hb9Ch6XjPL6Yh/mpVo8=; b=OxuwZLxOMJY2itZg2fylygRW2TDrhaVJ3UUx7tyD8kOGJ18sCjwBMw6hjKJ5vtLvoSEFWW QY1x9SK1Q5VJVXZhs0sjPrCvzmTGeDI/kUN/ub+h+szzb+k+xXb5ubkyGORIpwuRm9D8BB K8yc7tYmyaYpWAP1g7JYr661byBHkYA= Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-250-ROCw8HI2Myq22v6owZ-fPQ-1; Mon, 21 Sep 2026 16:57:39 -0400 X-MC-Unique: ROCw8HI2Myq22v6owZ-fPQ-1 X-Mimecast-MFC-AGG-ID: ROCw8HI2Myq22v6owZ-fPQ_1790024257 Received: from mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.12]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 54F161955D63; Mon, 21 Sep 2026 20:57:37 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.125]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 99F1E1956042; Mon, 21 Sep 2026 20:57:34 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Fabiano Rosas , Hanna Reitz , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Kevin Wolf , Vladimir Sementsov-Ogievskiy , Paolo Bonzini , Zhao Liu , Jason Wang , Eric Blake , qemu-block@nongnu.org, Igor Mammedov , Ani Sinha , "Michael S. Tsirkin" , John Snow , Peter Xu , Markus Armbruster , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Daniel=20P=2E=20Berrang=C3=A9?= Subject: [PATCH v2 06/10] qapi: convert/split intros for commands Date: Mon, 21 Sep 2026 16:57:08 -0400 Message-ID: <20260921205712.1862167-7-jsnow@redhat.com> In-Reply-To: <20260921205712.1862167-1-jsnow@redhat.com> References: <20260921205712.1862167-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: 12 X-Spam_score: 1.2 X-Spam_bar: + X-Spam_report: (1.2 / 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, RCVD_IN_SBL_CSS=3.335, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: qemu development 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-bounces+qemu-devel=archiver.kernel.org@nongnu.org This patch converts or splits intro sections for commands with more than one paragraph of text. Signed-off-by: John Snow --- qapi/control.json | 3 +-- qapi/introspect.json | 16 ++++++++-------- qapi/machine.json | 31 +++++++++++++++---------------- qapi/migration.json | 12 +++++------- qapi/misc-arm.json | 5 ++--- qapi/misc.json | 8 +++----- qapi/net.json | 3 +-- qapi/qdev.json | 9 ++++----- qapi/stats.json | 5 ++--- qapi/transaction.json | 6 +++--- qapi/ui.json | 3 +-- 11 files changed, 45 insertions(+), 56 deletions(-) diff --git a/qapi/control.json b/qapi/control.json index 2788ce32e2f..ef63a8a261b 100644 --- a/qapi/control.json +++ b/qapi/control.json @@ -152,8 +152,7 @@ ## # @quit: -# -# Request graceful QEMU process termination. +# Request graceful QEMU process termination. # # While every attempt is made to send the QMP response before # terminating, this is not guaranteed. When using this interface, a diff --git a/qapi/introspect.json b/qapi/introspect.json index bd42aac3358..d579e5c8554 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -17,15 +17,15 @@ ## # @query-qmp-schema: +# Command `query-qmp-schema` exposes the QMP wire ABI as an array +# of `SchemaInfo`. This lets QMP clients figure out what commands +# and events are available in this QEMU, and their parameters and +# results. # -# Command `query-qmp-schema` exposes the QMP wire ABI as an array of -# `SchemaInfo`. This lets QMP clients figure out what commands and -# events are available in this QEMU, and their parameters and results. -# -# However, the `SchemaInfo` can't reflect all the rules and -# restrictions that apply to QMP. It's interface introspection -# (figuring out what's there), not interface specification. The -# specification is in the QAPI schema. +# The `SchemaInfo` can't reflect all the rules and restrictions that +# apply to QMP. It's interface introspection (figuring out what's +# there), not interface specification. The specification is in the +# QAPI schema. # # Furthermore, while we strive to keep the QMP wire format # backwards-compatible across QEMU versions, the introspection output diff --git a/qapi/machine.json b/qapi/machine.json index 276258d9e5c..2d5c7c36ad9 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -2002,13 +2002,13 @@ ## # @query-cpu-model-comparison: +# Compares two CPU models, @modela and @modelb, returning how they +# compare in a specific configuration. # -# Compares two CPU models, @modela and @modelb, returning how they -# compare in a specific configuration. The results indicates how both -# models compare regarding runnability. This result can be used by -# tooling to make decisions if a certain CPU model will run in a -# certain configuration or if a compatible CPU model has to be created -# by baselining. +# The results indicates how both models compare regarding runnability. +# This result can be used by tooling to make decisions if a certain +# CPU model will run in a certain configuration or if a compatible CPU +# model has to be created by baselining. # # Usually, a CPU model is compared against the maximum possible CPU # model of a certain configuration (e.g. the "host" model for KVM). @@ -2058,11 +2058,10 @@ ## # @query-cpu-model-baseline: -# -# Baseline two CPU models, @modela and @modelb, creating a compatible -# third model. The created model will always be a static, -# migration-safe CPU model (see "static" CPU model expansion for -# details). +# Baseline two CPU models, @modela and @modelb, creating a +# compatible third model. The created model will always be a +# static, migration-safe CPU model (see "static" CPU model +# expansion for details). # # This interface can be used by tooling to create a compatible CPU # model out two CPU models. The created CPU model will be identical @@ -2130,11 +2129,11 @@ ## # @query-cpu-model-expansion: -# -# Expands a given CPU model, @model, (or a combination of CPU model + -# additional options) to different granularities, specified by @type, -# allowing tooling to get an understanding what a specific CPU model -# looks like in QEMU under a certain configuration. +# Expands a given CPU model, @model, (or a combination of CPU +# model + additional options) to different granularities, +# specified by @type, allowing tooling to get an understanding +# what a specific CPU model looks like in QEMU under a certain +# configuration. # # This interface can be used to query the "host" CPU model. # diff --git a/qapi/migration.json b/qapi/migration.json index a272e701385..8d3951ae429 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -1826,9 +1826,9 @@ ## # @calc-dirty-rate: -# -# Start measuring dirty page rate of the VM. Results can be retrieved -# with `query-dirty-rate` after measurements are completed. +# Start measuring dirty page rate of the VM. Results can be +# retrieved with `query-dirty-rate` after measurements are +# completed. # # Dirty page rate is the number of pages changed in a given time # period expressed in MiB/s. The following methods of calculation are @@ -1945,8 +1945,7 @@ ## # @set-vcpu-dirty-limit: -# -# Set the upper limit of dirty page rate for virtual CPUs. +# Set the upper limit of dirty page rate for virtual CPUs. # # Requires KVM with accelerator property "dirty-ring-size" set. A # virtual CPU's dirty page rate is a measure of its memory load. To @@ -1971,8 +1970,7 @@ ## # @cancel-vcpu-dirty-limit: -# -# Cancel the upper limit of dirty page rate for virtual CPUs. +# Cancel the upper limit of dirty page rate for virtual CPUs. # # Cancel the dirty page limit for the vCPU which has been set with # `set-vcpu-dirty-limit` command. Note that this command requires diff --git a/qapi/misc-arm.json b/qapi/misc-arm.json index 8cb2ea77951..9b018b29e2c 100644 --- a/qapi/misc-arm.json +++ b/qapi/misc-arm.json @@ -28,9 +28,8 @@ ## # @query-gic-capabilities: -# -# It will return a list of `GICCapability` objects that describe its -# capability bits. +# Returns a list of `GICCapability` objects that describe its +# capability bits. # # On non-ARM targets this command will report an error as the GIC # technology is not applicable. diff --git a/qapi/misc.json b/qapi/misc.json index b62cabc2b79..b4bb8a662e6 100644 --- a/qapi/misc.json +++ b/qapi/misc.json @@ -12,9 +12,8 @@ ## # @add_client: -# -# Allow client connections for VNC, Spice and socket based character -# devices to be passed in to QEMU via SCM_RIGHTS. +# Allow client connections for VNC, Spice and socket based +# character devices to be passed in to QEMU via SCM_RIGHTS. # # If the FD associated with @fdname is not a socket, the command will # fail and the FD will be closed. @@ -185,8 +184,7 @@ ## # @x-exit-preconfig: -# -# Exit from "preconfig" state +# Exit from "preconfig" state. # # This command makes QEMU exit the preconfig state and proceed with VM # initialization using configuration data provided on the command line diff --git a/qapi/net.json b/qapi/net.json index d0bacb4dcfe..b0a15fd53e2 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -37,8 +37,7 @@ ## # @netdev_add: -# -# Add a network backend. +# Add a network backend. # # Additional arguments depend on the type. # diff --git a/qapi/qdev.json b/qapi/qdev.json index a35321d2fd1..f390354d68e 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -162,11 +162,10 @@ ## # @device-sync-config: -# -# Synchronize device configuration from host to guest part. First, -# copy the configuration from the host part (backend) to the guest -# part (frontend). Then notify guest software that device -# configuration changed. +# Synchronize device configuration from host to guest part. +# First, copy the configuration from the host part (backend) to +# the guest part (frontend). Then notify guest software that +# device configuration changed. # # The command may be used to notify the guest about block device # capacity change. Currently only vhost-user-blk device supports diff --git a/qapi/stats.json b/qapi/stats.json index af57ec08546..e9d05390c31 100644 --- a/qapi/stats.json +++ b/qapi/stats.json @@ -175,9 +175,8 @@ ## # @query-stats: -# -# Return runtime-collected statistics for objects such as the VM or -# its vCPUs. +# Return runtime-collected statistics for objects such as the VM +# or its vCPUs. # # The arguments are a `StatsFilter` and specify the provider and # objects to return statistics about. diff --git a/qapi/transaction.json b/qapi/transaction.json index c0dc811ba61..02e1d072c63 100644 --- a/qapi/transaction.json +++ b/qapi/transaction.json @@ -198,9 +198,9 @@ ## # @transaction: # -# Executes a number of transactionable QMP commands atomically. If -# any operation fails, then the entire set of actions will be -# abandoned and the appropriate error returned. +# Executes a number of transactionable QMP commands atomically. +# If any operation fails, then the entire set of actions will be +# abandoned and the appropriate error returned. # # For external snapshots, the dictionary contains the device, the file # to use for the new snapshot, and the format. The default format, if diff --git a/qapi/ui.json b/qapi/ui.json index a59cd635774..73ee2cb2056 100644 --- a/qapi/ui.json +++ b/qapi/ui.json @@ -1198,8 +1198,7 @@ ## # @input-send-event: -# -# Send input event(s) to guest. +# Send input event(s) to guest. # # The @device and @head parameters can be used to send the input event # to specific input devices in case (a) multiple input devices of the -- 2.55.0