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 1F122C2BD09 for ; Sat, 6 Jul 2024 14:43:02 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sQ6cf-0006gJ-Vf; Sat, 06 Jul 2024 10:42:45 -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 1sQ6ce-0006fj-85 for qemu-devel@nongnu.org; Sat, 06 Jul 2024 10:42:44 -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 1sQ6cc-0002u6-OV for qemu-devel@nongnu.org; Sat, 06 Jul 2024 10:42:43 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720276960; 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=nigYOj92yn81mRKpNWix9os59iTbDueyOHBXxIDNvyA=; b=dWg6OSQTsm1RcLCs3NG6V9uDezfFFid96qZgIGUhCybi4ZTBDJ+PZAR2jqhHMuhwGmInnZ +jnIGzBuFmHUg6FzAKYbYmsQJnHn/snvFM1ilI2YQTo8VZYclP5qojZt5+xI/igVNAWw+Q RNJEgcbtXSUunpatmruFl6TcR/9grPk= 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-684-Tdem3hgsMBGMJvDtRIQTUQ-1; Sat, 06 Jul 2024 10:42:36 -0400 X-MC-Unique: Tdem3hgsMBGMJvDtRIQTUQ-1 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (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 1A4411956064; Sat, 6 Jul 2024 14:42:33 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A1238195605A; Sat, 6 Jul 2024 14:42:30 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 7E0D221E6757; Sat, 6 Jul 2024 16:42:28 +0200 (CEST) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, "Michael S. Tsirkin" , Peter Xu , qemu-block@nongnu.org, =?utf-8?Q?Marc-Andr=C3=A9?= Lureau , Kevin Wolf , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Peter Maydell , =?utf-8?Q?C=C3=A9dric?= Le Goater , Eduardo Habkost , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Paolo Bonzini , Fabiano Rosas , Pavel Dovgalyuk , Stefan Hajnoczi , Jason Wang , Lukas Straub , Ani Sinha , Igor Mammedov , Michael Roth , Hanna Reitz , Mads Ynddal , Alex Williamson , Eric Blake , Marcel Apfelbaum , Yanan Wang , Jiri Pirko Subject: Re: [PATCH 5/8] qapi: convert "Example" sections without titles In-Reply-To: <20240703210144.339530-6-jsnow@redhat.com> (John Snow's message of "Wed, 3 Jul 2024 17:01:40 -0400") References: <20240703210144.339530-1-jsnow@redhat.com> <20240703210144.339530-6-jsnow@redhat.com> Date: Sat, 06 Jul 2024 16:42:28 +0200 Message-ID: <87sewmtwdn.fsf@pond.sub.org> User-Agent: Gnus/5.13 (Gnus v5.13) MIME-Version: 1.0 Content-Type: text/plain X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 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 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-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > Use the no-option form of ".. qmp-example::" to convert any Examples > that do not have any form of caption or explanation whatsoever. Note > that in a few cases, example sections are split into two or more > separate example blocks. This is only done stylistically to create a > delineation between two or more logically independent examples. > > See commit-3: "docs/qapidoc: create qmp-example directive", for a > detailed explanation of this custom directive syntax. > > See commit+3: "qapi: remove "Example" doc section" for a detailed > explanation of why. > > Signed-off-by: John Snow [...] > diff --git a/qapi/run-state.json b/qapi/run-state.json > index 252d7d6afa7..718a3c958e9 100644 > --- a/qapi/run-state.json > +++ b/qapi/run-state.json [...] > @@ -453,7 +453,7 @@ > # > # Since: 5.0 > # > -# Example: > +# .. qmp-example:: > # > # <- { "event": "GUEST_CRASHLOADED", > # "data": { "action": "run" }, Trivial semantic conflict, we need @@ -469,7 +469,7 @@ # # Since: 9.1 # -# Example: +# .. qmp-example:: # # <- { "event": "GUEST_PVSHUTDOWN", # "timestamp": { "seconds": 1648245259, "microseconds": 893771 } } > @@ -597,7 +597,7 @@ > # > # Since: 5.2 > # > -# Example: > +# .. qmp-example:: > # > # <- { "event": "MEMORY_FAILURE", > # "data": { "recipient": "hypervisor", [...]