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 925EB4E36EF for ; Thu, 17 Sep 2026 19:46:48 +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=1789674410; cv=none; b=jLgTN0ocvOrs8pcYzGrGEipXVAV7AAt0UuUKYVSjTXWFmMvoMCo56Y9P2coqcRNuo6+YS7/I5FnrRkxqsEDsMMos41QQqo9zsk1AwvsuIO4jpfgPYD9IC3QdnYvFqMlC4tj5md20eEzl+zkbr6S88YWS37GM1HL16+rlvb0P2eg= ARC-Message-Signature:i=1; a=rsa-sha256; d=subspace.kernel.org; s=arc-20240116; t=1789674410; c=relaxed/simple; bh=rEALylabhbUB1xaVbK7MNHBVwfsBc6dDNnd2+jNbea0=; h=From:To:Cc:Subject:Date:Message-ID:In-Reply-To:References: MIME-Version:content-type; b=Ncr1O9nwtGLupKEBP8z+C3W6BpT4Y1cfvZHDuckBc5D5tt9cxCBfHTgRzmnbRQuB+6lfX6czZysNGn6ZhsuoE8pJNQ4g6rumlQpMiRypPbr8ZVdgBCmjdpk4W7xumcJUihfRnBi3U8Z0F0dUVfUGUa4+m4pq92Rlzv50Rj14ZBY= 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=WU/Dc+S9; 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="WU/Dc+S9" DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1789674407; 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=CQ5l2zQTKXrlbIqeocoytsYz76jJ9tSoC9AMPa4JXT4=; b=WU/Dc+S97NQAMHAfLeodNpafuKWjjZ2Jbf3NFMBYGZvCu388FygN3EHNHyRofoQRXG1wqf KCDWmP0rpKFrMt6utyWzaU9Rr8BXUPThMACaPcN9z40mb1H0l6gKY1LE6rVJRPeWSXFx60 KpOZ+MlDl2O+iDuBsXxvIGkBWjmuvfs= Received: from mx-prod-mc-06.mail-002.prod.us-west-2.aws.redhat.com (ec2-35-165-154-97.us-west-2.compute.amazonaws.com [35.165.154.97]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-692-F7cXhwGiN9aA31adMYohaw-1; Thu, 17 Sep 2026 15:46:43 -0400 X-MC-Unique: F7cXhwGiN9aA31adMYohaw-1 X-Mimecast-MFC-AGG-ID: F7cXhwGiN9aA31adMYohaw_1789674402 Received: from mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.17]) (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-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id ED0DC1800758; Thu, 17 Sep 2026 19:46:41 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.64.85]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id 3B2A419AC047; Thu, 17 Sep 2026 19:46:39 +0000 (UTC) From: John Snow To: qemu-devel@nongnu.org Cc: Markus Armbruster , Peter Xu , Junjie Cao , Michael Roth , Paolo Bonzini , Zhao Liu , linux-cxl@vger.kernel.org, Jason Wang , Eric Blake , Fabiano Rosas , =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Kevin Wolf , Hanna Reitz , qemu-block@nongnu.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Lukas Straub , Jonathan Cameron , John Snow Subject: [PATCH v5 7/7] qapi: convert intro sections followed by notes/examples Date: Thu, 17 Sep 2026 15:46:14 -0400 Message-ID: <20260917194614.549584-8-jsnow@redhat.com> In-Reply-To: <20260917194614.549584-1-jsnow@redhat.com> References: <20260917194614.549584-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.17 X-Mimecast-MFC-PROC-ID: 13EBMSrwGNDJr0dRvrhkCvLlbf7dAsJ5Epk7zPKPAg8_1789674402 X-Mimecast-Originator: redhat.com Content-Transfer-Encoding: 8bit content-type: text/plain; charset="US-ASCII"; x-default=true This patch converts intro sections that are immediately followed by ".. note::" or ".. qmp-example::", which provides a natural cutoff point. This patch does not change how these functions happen to be rendered, as they do not have any auto-generated documention inserted into them. Signed-off-by: John Snow --- qapi/migration.json | 15 +++++++-------- qapi/misc.json | 3 +-- qapi/run-state.json | 7 +++---- 3 files changed, 11 insertions(+), 14 deletions(-) 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