From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.133.124]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id 770C13812DB for ; Wed, 16 Sep 2026 13:59:36 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; arc=none smtp.client-ip=170.10.133.124 ARC-Seal:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789567178; cv=none; b=kKCxhgt4qhAc1bHiQ7HjBVchPjOEkvjL0T2LO4ImpNG9BdpraxxKhNWaGJFDBQnRT5rXc7NLPTt//zetnlOMOJuh1vzkLW+wsCj+bkEhgdFzshB6BCDi9PbbsLQfafoRrECy/wjZ9K3Ln/VKFEk3N+x8kLgh6TkQ3zhFxRi6N/I= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789567178; c=relaxed/simple; bh=eZjc0C8ESNGAHqDow+EMnxuRsWcslzuDp/Cljtuw+yI=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:content-type; b=tfmXj3ylTvrTQd3iqXI1bwgWiICrCrJubOGy/tmYCzm7cfBUhbt7fT7Oh+1+nWUnRxrQjS0URrkbCD8feFsnb/X3kX/JpvfMEkHMsNGZN7AO09kZ8Cl7i9oW5s7o8NytJQB37KASwi+psB6r9dR15cM8T6xJdUaxmXMxJ/+i+94= ARC-Authentication-Results:i=1; smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com; spf=pass smtp.mailfrom=redhat.com; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b=Mm9eAUEc; arc=none smtp.client-ip=170.10.133.124 Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=redhat.com Authentication-Results: smtp.subspace.kernel.org; spf=pass smtp.mailfrom=redhat.com Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=redhat.com header.i=@redhat.com header.b="Mm9eAUEc" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1789567175; 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=pxwSvjyweKaZCuJXGsfI9jwtz+eDtnLs/f3FZEar0W4=; b=Mm9eAUEcvyT+5eXrVGWuUoX4a4/j3AqLaXRu8NztMr8kZU9JRmulT1E3H948froz0pis8B 5pEQz032XC4fOYZ09NnEl7UMsxhWQ7j5h8Id3AiNCjeLW4ThnNzEJiGHd2Ad/b4hn//dlM g6tv2J55dZ5T513bR/XIc/nPLGDjevY= Received: from mx-prod-mc-01.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-688-z-zjJ5clOmqcVCrve-Z-qw-1; Wed, 16 Sep 2026 09:59:30 -0400 X-MC-Unique: z-zjJ5clOmqcVCrve-Z-qw-1 X-Mimecast-MFC-AGG-ID: z-zjJ5clOmqcVCrve-Z-qw_1789567169 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-01.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id D72F619540C8; Wed, 16 Sep 2026 13:59:28 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.46]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id E222A1956054; Wed, 16 Sep 2026 13:59:22 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Markus Armbruster , Zhao Liu , Peter Xu , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Jonathan Cameron , Eric Blake , Fabiano Rosas , Kevin Wolf , Michael Roth , linux-cxl@vger.kernel.org, qemu-block@nongnu.org, Junjie Cao , Lukas Straub , Hanna Reitz , Paolo Bonzini , Jason Wang , John Snow Subject: [PATCH v4 7/7] qapi: convert intro sections followed by notes/examples Date: Wed, 16 Sep 2026 09:58:41 -0400 Message-ID: <20260916135841.3614495-8-jsnow@redhat.com> In-Reply-To: <20260916135841.3614495-1-jsnow@redhat.com> References: <20260916135841.3614495-1-jsnow@redhat.com> Precedence: bulk X-Mailing-List: linux-cxl@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 X-Mimecast-MFC-PROC-ID: eP2t4IYgkU04gjXQ5g8JkSLy6WyUP6Tk2jIykhRqT_Q_1789567169 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true These provide a rather natural cutoff point, but technically this does introduce a new intro/details split to these documentation blocks. Signed-off-by: John Snow --- qapi/machine.json | 5 ++--- qapi/migration.json | 15 +++++++-------- qapi/misc.json | 3 +-- qapi/run-state.json | 7 +++---- 4 files changed, 13 insertions(+), 17 deletions(-) diff --git a/qapi/machine.json b/qapi/machine.json index 84d95c8d87f..276258d9e5c 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -1209,9 +1209,8 @@ ## # @HV_BALLOON_STATUS_REPORT: -# -# Emitted when the hv-balloon driver receives a "STATUS" message from -# the guest. +# Emitted when the hv-balloon driver receives a "STATUS" message +# from the guest. # # .. note:: This event is rate-limited. # diff --git a/qapi/migration.json b/qapi/migration.json index d571c06fc20..a272e701385 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -1254,10 +1254,10 @@ ## # @migrate_cancel: -# -# Cancel the currently executing migration process. Allows a new -# migration to be started right after. When postcopy-ram is in use, -# cancelling is not allowed after the postcopy phase has started. +# Cancel the currently executing migration process. Allows a new +# migration to be started right after. When postcopy-ram is in +# use, cancelling is not allowed after the postcopy phase has +# started. # # .. note:: This command succeeds even if there is no migration # process running. @@ -1632,8 +1632,8 @@ ## # @xen-colo-do-checkpoint: -# -# Xen uses this command to notify replication to trigger a checkpoint. +# Xen uses this command to notify replication to trigger a +# checkpoint. # # .. qmp-example:: # @@ -1700,8 +1700,7 @@ ## # @migrate-pause: -# -# Pause a migration. Currently it only supports postcopy. +# Pause a migration. Currently it only supports postcopy. # # .. qmp-example:: # diff --git a/qapi/misc.json b/qapi/misc.json index b7d08532768..b62cabc2b79 100644 --- a/qapi/misc.json +++ b/qapi/misc.json @@ -103,8 +103,7 @@ ## # @query-iothreads: -# -# Return a list of information about each iothread. +# Return a list of information about each iothread. # # .. note:: This list excludes the QEMU main loop thread, which is not # declared using the ``-object iothread`` command-line option. It diff --git a/qapi/run-state.json b/qapi/run-state.json index 703ca1bb5b9..8bbd9884087 100644 --- a/qapi/run-state.json +++ b/qapi/run-state.json @@ -232,10 +232,9 @@ ## # @SUSPEND_DISK: -# -# Emitted when guest enters a hardware suspension state with data -# saved on disk, for example, S4 state, which is sometimes called -# hibernate state +# Emitted when guest enters a hardware suspension state with data +# saved on disk, for example, S4 state, which is sometimes called +# hibernate state # # .. note:: QEMU shuts down (similar to event `SHUTDOWN`) when # entering this state. -- 2.55.0