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 DAAACC282DE for ; Mon, 10 Mar 2025 09:48:08 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1trZjm-0002Wz-7y; Mon, 10 Mar 2025 05:47:54 -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 1trZj4-00027H-TY for qemu-devel@nongnu.org; Mon, 10 Mar 2025 05:47:21 -0400 Received: from us-smtp-delivery-124.mimecast.com ([170.10.129.124]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1trZj0-0002Jc-RZ for qemu-devel@nongnu.org; Mon, 10 Mar 2025 05:47:09 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741600025; 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=cZQfOfy6+HrqKttJBxI8kyttK8A388Bbnsrgq88HXZQ=; b=EgkL+Xd/RTJqjHThwCNAoKKQUM8P5cpXQmxd+Cux/NXIIndaMQjBbSIEH6dcQHB+Vcj0DU vPz7cpWGMXsClf53k+YcXtYBIsRY6QkfH6JS61/UDWp/LUwd08QFPT5DGgJtnpDbcC/GiT zfJQuszD2Q7wx2R0tzaih6q+dYUrP7M= Received: from mx-prod-mc-04.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-149-RWDijdTVPyyXX4oFchfprQ-1; Mon, 10 Mar 2025 05:47:01 -0400 X-MC-Unique: RWDijdTVPyyXX4oFchfprQ-1 X-Mimecast-MFC-AGG-ID: RWDijdTVPyyXX4oFchfprQ_1741600020 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-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 5C89719560A3; Mon, 10 Mar 2025 09:46:59 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.44.22.4]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 187931956096; Mon, 10 Mar 2025 09:46:59 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BF70821E66C1; Mon, 10 Mar 2025 10:46:56 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Markus Armbruster , Philippe =?utf-8?Q?Mathieu-Daud=C3=A9?= , Michael Roth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= , Eric Blake , Thomas Huth , Alex =?utf-8?Q?Ben?= =?utf-8?Q?n=C3=A9e?= , Peter Maydell Subject: Re: [PATCH v2 43/62] docs/qapidoc: add preamble() method In-Reply-To: <20250309083550.5155-44-jsnow@redhat.com> (John Snow's message of "Sun, 9 Mar 2025 04:35:30 -0400") References: <20250309083550.5155-1-jsnow@redhat.com> <20250309083550.5155-44-jsnow@redhat.com> Date: Mon, 10 Mar 2025 10:46:56 +0100 Message-ID: <8734flgqun.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.17 Received-SPF: pass client-ip=170.10.129.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_H5=0.001, RCVD_IN_MSPIKE_WL=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 method adds the options/preamble to each definition block. Notably, > :since: and :ifcond: are added, as are any "special features" such as > :deprecated: and :unstable:. > > Signed-off-by: John Snow > --- > docs/sphinx/qapidoc.py | 41 ++++++++++++++++++++++++++++++++++++++--- > 1 file changed, 38 insertions(+), 3 deletions(-) > > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index cf5dbb0133d..d8bf0073dfa 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -37,7 +37,12 @@ > from docutils.parsers.rst import Directive, directives > from docutils.statemachine import StringList > from qapi.error import QAPIError > -from qapi.schema import QAPISchema, QAPISchemaVisitor > +from qapi.parser import QAPIDoc > +from qapi.schema import ( > + QAPISchema, > + QAPISchemaDefinition, > + QAPISchemaVisitor, > +) > from qapi.source import QAPISourceInfo > > from qapidoc_legacy import QAPISchemaGenRSTVisitor # type: ignore > @@ -56,8 +61,6 @@ > Sequence, > ) > > - from qapi.parser import QAPIDoc > - > from sphinx.application import Sphinx > from sphinx.util.typing import ExtensionMetadata > > @@ -125,6 +128,38 @@ def ensure_blank_line(self) -> None: > # +2: correct for zero/one index, then increment by one. > self.add_line_raw("", fname, line + 2) > > + # Transmogrification helpers > + > + def preamble(self, ent: QAPISchemaDefinition) -> None: > + """ > + Generate option lines for qapi entity directives. QAPI index unless there's a reason for lower case. > + """ [...]