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 08321C282DE for ; Fri, 7 Mar 2025 12:16:45 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tqWcu-0007I8-M4; Fri, 07 Mar 2025 07:16:29 -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 1tqWcf-00077d-1P for qemu-devel@nongnu.org; Fri, 07 Mar 2025 07:16:13 -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 1tqWcd-0006sU-9S for qemu-devel@nongnu.org; Fri, 07 Mar 2025 07:16:12 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1741349769; 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=+QSL8URFIOften0yfmY7zlUxMox6H8IOuAm+8FBDic8=; b=NFdhSaiklwyPSpUQx0caDmANzr63ZPG9Z8WuUchuVKfxlVUIkAxml40nqD8noUPpr+OngU andvuwtql9Z6buLnTKBIT1g7oaPOq31bhDyyb/8ufHi/R7R26xzeDjgL9+2jEETxZKo3jW 0Ux2fsJTsW+R4tHfrlcJv/uKcKFWtX0= 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-634-0Xt4IenvNP-jClVxOVy7fA-1; Fri, 07 Mar 2025 07:16:06 -0500 X-MC-Unique: 0Xt4IenvNP-jClVxOVy7fA-1 X-Mimecast-MFC-AGG-ID: 0Xt4IenvNP-jClVxOVy7fA_1741349765 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 A4644180025C; Fri, 7 Mar 2025 12:16:05 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.15]) by mx-prod-int-05.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 58C721955F39; Fri, 7 Mar 2025 12:16:05 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id EB91521E675F; Fri, 07 Mar 2025 13:16:02 +0100 (CET) From: Markus Armbruster To: John Snow Cc: qemu-devel@nongnu.org, Michael Roth , Alex =?utf-8?Q?Benn=C3=A9e?= , Philippe =?utf-8?Q?Mat?= =?utf-8?Q?hieu-Daud=C3=A9?= , Peter Maydell , Thomas Huth , Daniel P. =?utf-8?Q?Berrang=C3=A9?= Subject: Re: [PATCH 46/57] docs/qapidoc: add visit_feature() method In-Reply-To: <20250305034610.960147-47-jsnow@redhat.com> (John Snow's message of "Tue, 4 Mar 2025 22:45:55 -0500") References: <20250305034610.960147-1-jsnow@redhat.com> <20250305034610.960147-47-jsnow@redhat.com> Date: Fri, 07 Mar 2025 13:16:02 +0100 Message-ID: <87bjudjat9.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.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_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 adds a simple ":feat name: lorem ipsum ..." line to the generated > rST document, so at the moment it's only for "top level" features. > > Signed-off-by: John Snow > --- > docs/sphinx/qapidoc.py | 9 +++++++++ > 1 file changed, 9 insertions(+) > > diff --git a/docs/sphinx/qapidoc.py b/docs/sphinx/qapidoc.py > index b87ce288837..eaea19af7ac 100644 > --- a/docs/sphinx/qapidoc.py > +++ b/docs/sphinx/qapidoc.py > @@ -195,6 +195,15 @@ def visit_paragraph(self, section: QAPIDoc.Section) -> None: > self.add_lines(section.text, section.info) > self.ensure_blank_line() > > + def visit_feature(self, section: QAPIDoc.ArgSection) -> None: > + # FIXME - ifcond for features is not handled at all yet! > + # Proposal: decorate the right-hand column with some graphical > + # element to indicate conditional availability? Is the FIXME worth mentioning in the commit message? > + assert section.text # Guaranteed by parser.py > + assert section.member > + > + self.generate_field("feat", section.member, section.text, section.info) > + > def visit_errors(self, section: QAPIDoc.Section) -> None: > # FIXME: the formatting for errors may be inconsistent and may > # or may not require different newline placement to ensure