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 0D11EC021A1 for ; Wed, 12 Feb 2025 09:38:46 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ti9Bj-0006Mw-4h; Wed, 12 Feb 2025 04:37:47 -0500 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 1ti9Bb-0006MH-Dl for qemu-devel@nongnu.org; Wed, 12 Feb 2025 04:37:40 -0500 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 1ti9BY-00035R-E1 for qemu-devel@nongnu.org; Wed, 12 Feb 2025 04:37:38 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1739353053; 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=J4DlSqZPTwLAkxnyJV2EIND7acY0NZ0b6Sck12amtWA=; b=YFp9SOTF+fhfbbnOxq8sFenjSNcMX6WVAgx/O27meitOoDhV055QAjemNLQLa2UZ4Ud0o6 QwfiauIHxLZpmtROYNSyeewFl1xMxF4jAFIm3j1vfPELit30K3mjxDflNFuqCYlMONvSYt 3t9ALIqcxZPsC9CX3PvQTjV8GG4dccs= Received: from mx-prod-mc-08.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-408-fkcc6raoPR6jQvNj3QTiFA-1; Wed, 12 Feb 2025 04:37:28 -0500 X-MC-Unique: fkcc6raoPR6jQvNj3QTiFA-1 X-Mimecast-MFC-AGG-ID: fkcc6raoPR6jQvNj3QTiFA 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-08.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 6DB21180087C; Wed, 12 Feb 2025 09:37:26 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.22]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 8AE5B19560A3; Wed, 12 Feb 2025 09:37:25 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id F3F7E21E6A28; Wed, 12 Feb 2025 10:37:22 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Peter Maydell , Thomas Huth , Yanan Wang , Fabiano Rosas , Zhao Liu , Lukas Straub , Eduardo Habkost , Michael Roth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Peter Xu , Eric Blake , Marcel Apfelbaum , Alex =?utf-8?Q?Benn=C3=A9e?= , Jason Wang , Paolo Bonzini , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= Subject: Re: [PATCH 29/42] qapi: Add "Details:" disambiguation marker In-Reply-To: <20250205231208.1480762-30-jsnow@redhat.com> (John Snow's message of "Wed, 5 Feb 2025 18:11:55 -0500") References: <20250205231208.1480762-1-jsnow@redhat.com> <20250205231208.1480762-30-jsnow@redhat.com> Date: Wed, 12 Feb 2025 10:37:22 +0100 Message-ID: <871pw3qzal.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.12 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: -35 X-Spam_score: -3.6 X-Spam_bar: --- X-Spam_report: (-3.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-1.54, 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_H2=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 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+qemu-devel=archiver.kernel.org@nongnu.org Sender: qemu-devel-bounces+qemu-devel=archiver.kernel.org@nongnu.org John Snow writes: > This clarifies sections that are mistaken by the parser as "intro" > sections to be "details" sections instead. Impact on output? See notes inline. > > Signed-off-by: John Snow > --- > qapi/machine.json | 2 ++ > qapi/migration.json | 4 ++++ > qapi/qom.json | 4 ++++ > qapi/yank.json | 2 ++ > scripts/qapi/parser.py | 8 ++++++++ > 5 files changed, 20 insertions(+) > > diff --git a/qapi/machine.json b/qapi/machine.json > index a6b8795b09e..3c1b397f6cc 100644 > --- a/qapi/machine.json > +++ b/qapi/machine.json > @@ -1301,6 +1301,8 @@ > # Return the amount of initially allocated and present hotpluggable > # (if enabled) memory in bytes. > # > +# Details: > +# > # .. qmp-example:: > # > # -> { "execute": "query-memory-size-summary" } Output unchanged in my testing. Same for the other hunks unless otherwise noted. > diff --git a/qapi/migration.json b/qapi/migration.json > index 43babd1df41..9070a91e655 100644 > --- a/qapi/migration.json > +++ b/qapi/migration.json > @@ -1920,6 +1920,8 @@ > # > # Xen uses this command to notify replication to trigger a checkpoint. > # > +# Details: > +# > # .. qmp-example:: > # > # -> { "execute": "xen-colo-do-checkpoint" } > @@ -1993,6 +1995,8 @@ > # > # Pause a migration. Currently it only supports postcopy. > # > +# Details: > +# > # .. qmp-example:: > # > # -> { "execute": "migrate-pause" } > diff --git a/qapi/qom.json b/qapi/qom.json > index 11277d1f84c..5d285ef9239 100644 > --- a/qapi/qom.json > +++ b/qapi/qom.json > @@ -729,6 +729,8 @@ > # > # Properties for memory-backend-shm objects. > # > +# Details: > +# > # This memory backend supports only shared memory, which is the > # default. > # The paragraphs moves from above to below the auto-generated member documentation, like this: @@ -25908,13 +25908,13 @@ If Properties for memory-backend-shm objects. -This memory backend supports only shared memory, which is the default. - Members ~~~~~~~ The members of "MemoryBackendProperties" +This memory backend supports only shared memory, which is the default. + Since ~~~~~ This is sphinx-build -b text. I don't understand why there is no blank line between "The members of ... " and the moved paragraph. > @@ -744,6 +746,8 @@ > # > # Properties for memory-backend-epc objects. > # > +# Details: > +# > # The @merge boolean option is false by default with epc > # > # The @dump boolean option is false by default with epc Likewise. > diff --git a/qapi/yank.json b/qapi/yank.json > index 30f46c97c98..4d36d21e76a 100644 > --- a/qapi/yank.json > +++ b/qapi/yank.json > @@ -104,6 +104,8 @@ > # > # Returns: list of @YankInstance > # > +# Details: > +# > # .. qmp-example:: > # > # -> { "execute": "query-yank" } > diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py > index c5d2b950a82..5890a13b5ba 100644 > --- a/scripts/qapi/parser.py > +++ b/scripts/qapi/parser.py > @@ -544,6 +544,14 @@ def _tag_check(what: str) -> None: > raise QAPIParseError( > self, 'feature descriptions expected') > have_tagged = True > + elif line == 'Details:': > + _tag_check("Details") > + self.accept(False) > + line = self.get_doc_line() > + while line == '': > + self.accept(False) > + line = self.get_doc_line() > + have_tagged = True > elif match := self._match_at_name_colon(line): > # description > if have_tagged: