From nobody Sat Nov 15 05:35:30 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1754718679; cv=none; d=zohomail.com; s=zohoarc; b=kyEDB3OOh18lZ+sGNULBD8wIVew0w8MT88fsiXuzNBRqV9CpuUleQxonPVfmRbkUFBgJiJ24eqO8gzcaGscXxIU+QQ7fuEGsg0H1wegjBfRsv4iw/Tlpmoc1fhmuwVUjFmfn5nvsYIgMBKpvLjqi0idWfZJZJPnHFXXQOzaQUqY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754718679; 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=8STwwrBJYcYwqTQnBTm+Dh8pn1ht5aP6l3EsrmXF+2E=; b=HPJJ6mNNTY8rlkU7gmT0lSZovUZLuy3t6REenov8K8haaSCNAv0HoZJHHAOYtlI9yCQuU3lZSjQzCmpfp+2yRtshrpYisebgUuqlAebMUtSPT7bjZRqgZKH8v5axsbds4HPqrWgfex+AECNee2S71e7cqc522r4iGjzrhnJVh9I= 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=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1754718679831348.0922747187757; Fri, 8 Aug 2025 22:51:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ukcTW-0001tF-9a; Sat, 09 Aug 2025 01:50:38 -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 1ukcTV-0001sn-7b for qemu-devel@nongnu.org; Sat, 09 Aug 2025 01:50:37 -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 1ukcTS-0002Hf-Nh for qemu-devel@nongnu.org; Sat, 09 Aug 2025 01:50:36 -0400 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-549-7b6vl5qCMACUsF40jkwTBw-1; Sat, 09 Aug 2025 01:50:31 -0400 Received: from mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.93]) (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 1A55B18003FC for ; Sat, 9 Aug 2025 05:50:30 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.18]) by mx-prod-int-06.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id C6B7518002B4 for ; Sat, 9 Aug 2025 05:50:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id E964421E6924; Sat, 09 Aug 2025 07:50:26 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1754718633; 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=8STwwrBJYcYwqTQnBTm+Dh8pn1ht5aP6l3EsrmXF+2E=; b=ISLGTiolRS08PfIVSP/EemmBY1BoA/L95dQxcGKfDqFWgWkIAioxr/J1q98U3y5OiA4C1n se7KlchPZc/DGbiZGXPhDVk9RPIYryiVQvKDbcqq3wbC39fZTYPkFRVarl3S/JzEojWxqK Q6BhwmsX/1aAEKsG2OytOtm3bi0LlPQ= X-MC-Unique: 7b6vl5qCMACUsF40jkwTBw-1 X-Mimecast-MFC-AGG-ID: 7b6vl5qCMACUsF40jkwTBw_1754718630 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, John Snow Subject: [PULL 1/3] docs/devel/qapi-code-gen: Add two cross-references we missed Date: Sat, 9 Aug 2025 07:50:24 +0200 Message-ID: <20250809055026.2944835-2-armbru@redhat.com> In-Reply-To: <20250809055026.2944835-1-armbru@redhat.com> References: <20250809055026.2944835-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.30.177.93 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.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_PASS=-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: 1754718683932116600 Content-Type: text/plain; charset="utf-8" Missed in commit 9c66762a601 (docs/qapi-code-gen: add cross-references). Signed-off-by: Markus Armbruster Message-ID: <20250731054044.4011789-2-armbru@redhat.com> Reviewed-by: John Snow --- docs/devel/qapi-code-gen.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index dfdbeac5a5..138921b386 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -646,9 +646,9 @@ Member 'event' names the event. This is the event name= used in the Client JSON Protocol. =20 Member 'data' defines the event-specific data. It defaults to an -empty MEMBERS object. +empty MEMBERS_ object. =20 -If 'data' is a MEMBERS object, then MEMBERS defines event-specific +If 'data' is a MEMBERS_ object, then MEMBERS defines event-specific data just like a struct type's 'data' defines struct type members. =20 If 'data' is a STRING, then STRING names a complex type whose members --=20 2.49.0 From nobody Sat Nov 15 05:35:30 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1754718667; cv=none; d=zohomail.com; s=zohoarc; b=LdTCu448ICFFdnsE4BqCDpOBJI2gbWnYybWIhbspWFzMS0LCrcRDHdfavq0GS8Ja8I4c3TG6rjReu+HtpiTAhBsQPN8w3PMrk2VlliX/XT9uU03xjyBQ2wV6AkXkjLqOODU5/m83qUo6dRHPD+VAM+wnwEvRhh42qp5dny2Ig14= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754718667; 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=QaDoeL5DyFczd3jVxAe2QCI8h3IBnZohyaWArlgB8R4=; b=fCe3bO19yIO84idmUEX+lk+WzF/CnomZtB9dQ0qjL/qzYJ9cdcunIvLTu6PzIsI0t2eJs0XEF7GCyD5KVowcokGEK5c5P2USyopwx7ipRs7X/aPsC272aJR/F0G7bSrv/SM9XXPpAhTVqOkpr6lmMfmSITQHI/NmVb4eTUnimcE= 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=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1754718667741376.5402358140709; Fri, 8 Aug 2025 22:51:07 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ukcTa-0001w7-4G; Sat, 09 Aug 2025 01:50:42 -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 1ukcTW-0001tC-4i for qemu-devel@nongnu.org; Sat, 09 Aug 2025 01:50:38 -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 1ukcTS-0002Hb-NV for qemu-devel@nongnu.org; Sat, 09 Aug 2025 01:50:37 -0400 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-663-p_-hkcOuODu2DJ4ea2l2gg-1; Sat, 09 Aug 2025 01:50:31 -0400 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 846771800347 for ; Sat, 9 Aug 2025 05:50:30 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.18]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id DDAD519560B0 for ; Sat, 9 Aug 2025 05:50:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id ED36421E6925; Sat, 09 Aug 2025 07:50:26 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1754718633; 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=QaDoeL5DyFczd3jVxAe2QCI8h3IBnZohyaWArlgB8R4=; b=Ze4YctLGkn8rRH0+xo0CIE8LqqWKcPS0chqR0UKDlNt4ZQd22jr7TD40tXnU535pcVAJ09 jsG4qrOImaimt/UI8pyGo6tZlFygMAhcuNulR5Z8jRZNoAp3l4wFaFJ+G3nb+U+6/lUVmm Wgliq3ZVqQk9Ue3niZIKTwvpZfXu8is= X-MC-Unique: p_-hkcOuODu2DJ4ea2l2gg-1 X-Mimecast-MFC-AGG-ID: p_-hkcOuODu2DJ4ea2l2gg_1754718630 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, John Snow Subject: [PULL 2/3] docs/devel/qapi-code-gen: Fix typos in QAPI schema language grammar Date: Sat, 9 Aug 2025 07:50:25 +0200 Message-ID: <20250809055026.2944835-3-armbru@redhat.com> In-Reply-To: <20250809055026.2944835-1-armbru@redhat.com> References: <20250809055026.2944835-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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.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_PASS=-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: 1754718672604124100 Content-Type: text/plain; charset="utf-8" Fixes: 3248c1aaf2db (docs: update the documentation upfront about schema co= nfiguration) Signed-off-by: Markus Armbruster Message-ID: <20250731054044.4011789-3-armbru@redhat.com> Reviewed-by: John Snow --- docs/devel/qapi-code-gen.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 138921b386..2cd51729c3 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -786,8 +786,8 @@ Configuring the schema Syntax:: =20 COND =3D STRING - | { 'all: [ COND, ... ] } - | { 'any: [ COND, ... ] } + | { 'all': [ COND, ... ] } + | { 'any': [ COND, ... ] } | { 'not': COND } =20 All definitions take an optional 'if' member. Its value must be a --=20 2.49.0 From nobody Sat Nov 15 05:35:30 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=quarantine dis=none) header.from=redhat.com ARC-Seal: i=1; a=rsa-sha256; t=1754718679; cv=none; d=zohomail.com; s=zohoarc; b=cJcv+0Wdqvp4blQiNPLZSDLfjIC63UBs+HPlS7HiZkcqbPsPaqVOY9GnRlbrQ8UyBkh2uNLs2Vwlqc7ocr+RZmVM+cnh4ChBb5F3r7Zcy09lCbPoE3QWLumb9oGbldcRPlU1GQqmonMOZ/IIQV0psaml8zXClESOtdMuF4MiO1c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1754718679; 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=mBh4s9w4E0rzgSovMPgUd6Go9+lWP90O+HqnEfxoKb0=; b=VQVcG309+r+TIzcshoAUvXEFvt8KC4XtXLqVQZV6qxOVbA+FJwO3h8MdzG/UoJffp5iv9WiIqrijwP/TXafmGP0hGzzPvcZuNyBGwnyLlOK8MA6XmhhMLHphkwQ5NwNjLdhyBcdlwWnG3O0tXnyrwM4PnhqDevGhDShHoe0U4Kw= 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=quarantine dis=none) Return-Path: Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mx.zohomail.com with SMTPS id 1754718679055285.3942536493463; Fri, 8 Aug 2025 22:51:19 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ukcTX-0001tz-TX; Sat, 09 Aug 2025 01:50:39 -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 1ukcTW-0001tA-1m for qemu-devel@nongnu.org; Sat, 09 Aug 2025 01:50:38 -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 1ukcTS-0002Hd-Nq for qemu-devel@nongnu.org; Sat, 09 Aug 2025 01:50:37 -0400 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-501-W8pNU6FBOIuyvwp-Me1trw-1; Sat, 09 Aug 2025 01:50:30 -0400 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 3914D1800342 for ; Sat, 9 Aug 2025 05:50:30 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.45.242.18]) by mx-prod-int-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id C8B2019560AD for ; Sat, 9 Aug 2025 05:50:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id F1EAA21E6935; Sat, 09 Aug 2025 07:50:26 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1754718633; 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=mBh4s9w4E0rzgSovMPgUd6Go9+lWP90O+HqnEfxoKb0=; b=C6UOj+t7j/Q+VEm69rKFSxFvwIT5SBTjfOdbN3QCAK2IdBwnCwczCSHE4NESxl9rt0TvVi i907NH0LyJkVUz90kZ1q9jHhPPzDpLM6jIfm5cVfBo3uiJTZcYvDS7E7VoLgOnJoS/DnCB cJyyCtRdPcNUtfF1l11h/TzYWtfWzUE= X-MC-Unique: W8pNU6FBOIuyvwp-Me1trw-1 X-Mimecast-MFC-AGG-ID: W8pNU6FBOIuyvwp-Me1trw_1754718630 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: stefanha@redhat.com, John Snow Subject: [PULL 3/3] docs/devel/qapi-code-gen: Update cross-reference syntax Date: Sat, 9 Aug 2025 07:50:26 +0200 Message-ID: <20250809055026.2944835-4-armbru@redhat.com> In-Reply-To: <20250809055026.2944835-1-armbru@redhat.com> References: <20250809055026.2944835-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.12 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.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_PASS=-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: 1754718680640116600 Content-Type: text/plain; charset="utf-8" The new QAPI code generator creates a cross-reference target for each definition documentation. Enabled for the QEMU QMP Reference manual in commit a377f39f38f, and for the QEMU Storage Daemon QMP Reference Manual and the QEMU Guest Agent Protocol Reference in commit a6af5443440. We've put these targets to use since, but neglected to update doc comment markup documentation. Do that now. Co-developed-by: John Snow Signed-off-by: John Snow Signed-off-by: Markus Armbruster Message-ID: <20250731054044.4011789-4-armbru@redhat.com> --- docs/devel/qapi-code-gen.rst | 11 ++++++++--- docs/devel/qapi-domain.rst | 1 + 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index 2cd51729c3..d97602f464 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -943,9 +943,14 @@ The usual ****strong****, *\*emphasized\** and ````lit= eral```` markup should be used. If you need a single literal ``*``, you will need to backslash-escape it. =20 -Use ``@foo`` to reference a name in the schema. This is an rST -extension. It is rendered the same way as ````foo````, but carries -additional meaning. +Use ```foo``` to reference a definition in the schema. This generates +a link to the definition. In the event that such a cross-reference is +ambiguous, you can use `QAPI cross-reference roles +` to disambiguate. + +Use @foo to reference a member description within the current +definition. This is an rST extension. It is currently rendered the +same way as ````foo````, but carries additional meaning. =20 Example:: =20 diff --git a/docs/devel/qapi-domain.rst b/docs/devel/qapi-domain.rst index fe540d1e40..1924f12d42 100644 --- a/docs/devel/qapi-domain.rst +++ b/docs/devel/qapi-domain.rst @@ -375,6 +375,7 @@ Will allow you to add arbitrary field lists in QAPI dir= ectives:: =20 :see also: Lorem ipsum, dolor sit amet ... =20 +.. _QAPI-domain-cross-references: =20 Cross-references =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D --=20 2.49.0