From nobody Wed Jan 29 00:04:59 2025 Delivered-To: importer@patchew.org Authentication-Results: mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass(p=none dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1734052505; cv=none; d=zohomail.com; s=zohoarc; b=UiihZmz/w1PyagKXWyDbjynLXv2qUevBv+F8JLohtMmYYrD+1aTMJdA+j1O2IMQg+av4SWQJpU+d/S5pZJe9RAB/66Efi0LG7zcCr4jRUz6TIr3gBN2xqW931+hAlxDHkiI6Vu35aUTtCK7irQYnNdbcp5ABgWOL2m6A++fihZA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1734052505; h=Content-Transfer-Encoding:Cc:Cc:Date:Date:From:From:In-Reply-To:List-Subscribe:List-Post:List-Id:List-Archive:List-Help:List-Unsubscribe:MIME-Version:Message-ID:References:Sender:Subject:Subject:To:To:Message-Id:Reply-To; bh=xQSRk5rVnXkv2Ir8hXt5mWcFR2B4kKiqbhFHdu0NBDo=; b=Bo7rxyb+ydzSkqiK52bEFQe6CONeu8sh8mTlU4kbXcB6thCCiCp/4OuNMiy7Zlq+lWPnoeJritsbXMc0uV+ZDBTrBB6R12uUzhIEqVoubBWFEmR1nojPY46gMEIKRQqMZHs/3a6j/wSnJR8m1uhLe6sm67uunyOgymYXsCQcZGA= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass; spf=pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=qemu-devel-bounces+importer=patchew.org@nongnu.org; dmarc=pass header.from= (p=none dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1734052505547225.4561720684743; Thu, 12 Dec 2024 17:15:05 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLuGJ-00063q-E9; Thu, 12 Dec 2024 20:14:37 -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 1tLuGD-0005yC-TW for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:30 -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 1tLuGB-0000ey-Mf for qemu-devel@nongnu.org; Thu, 12 Dec 2024 20:14:28 -0500 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-340-SZEspY-7Nxam9dVZerkaJQ-1; Thu, 12 Dec 2024 20:14:23 -0500 Received: from mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.15]) (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 EF91B19560B2; Fri, 13 Dec 2024 01:14:21 +0000 (UTC) Received: from jsnow-thinkpadp16vgen1.westford.csb (unknown [10.22.88.22]) by mx-prod-int-02.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTP id C6D5E1956086; Fri, 13 Dec 2024 01:14:19 +0000 (UTC) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1734052466; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=xQSRk5rVnXkv2Ir8hXt5mWcFR2B4kKiqbhFHdu0NBDo=; b=IYrABrwGPIARRN/AExdzTd1/fpXjJ2dbR13Y/jKHdiPPIPzg5/MpQ+BIrigrlVSb9cFeXq EC+7vjmIdiW+jf7EuwFm07KeubzZF4UTJ8FABFDqc0OyBrgKPh+k3kdaE8PJYgnOzi1DE7 UJrrYkM7IiVQGZ9uRMSP4kg5IWRD1D8= X-MC-Unique: SZEspY-7Nxam9dVZerkaJQ-1 X-Mimecast-MFC-AGG-ID: SZEspY-7Nxam9dVZerkaJQ From: John Snow To: qemu-devel@nongnu.org Cc: Michael Roth , Markus Armbruster , Peter Maydell , =?UTF-8?q?Marc-Andr=C3=A9=20Lureau?= , Victor Toso de Carvalho , Paolo Bonzini , John Snow Subject: [RFC PATCH v2 17/35] docs/qapi-domain: add returns-nodesc Date: Thu, 12 Dec 2024 20:12:46 -0500 Message-ID: <20241213011307.2942030-18-jsnow@redhat.com> In-Reply-To: <20241213011307.2942030-1-jsnow@redhat.com> References: <20241213011307.2942030-1-jsnow@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.15 Received-SPF: pass (zohomail.com: domain of gnu.org designates 209.51.188.17 as permitted sender) client-ip=209.51.188.17; envelope-from=qemu-devel-bounces+importer=patchew.org@nongnu.org; helo=lists.gnu.org; Received-SPF: pass client-ip=170.10.133.124; envelope-from=jsnow@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -25 X-Spam_score: -2.6 X-Spam_bar: -- X-Spam_report: (-2.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.496, 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+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1734052507148116600 Content-Type: text/plain; charset="utf-8" This form is used to annotate a return type without an accompanying description, for when there is no "Returns:" information in the source doc, but we have a return type we want to generate a cross-reference to. Signed-off-by: John Snow --- docs/sphinx/qapi-domain.py | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/sphinx/qapi-domain.py b/docs/sphinx/qapi-domain.py index c8c8ffc0dce..c46c87168bd 100644 --- a/docs/sphinx/qapi-domain.py +++ b/docs/sphinx/qapi-domain.py @@ -275,6 +275,14 @@ class QAPICommand(QAPIObject): names=3D("return", "returns"), can_collapse=3DTrue, ), + # :returns-nodesc: TypeName + Field( + "returnvalue", + label=3D_("Returns"), + names=3D("returns-nodesc",), + bodyrolename=3D"type", + has_arg=3DFalse, + ), ] ) =20 --=20 2.47.0