From nobody Tue Nov 26 14:37:12 2024 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=1706250576; cv=none; d=zohomail.com; s=zohoarc; b=gQJSXkSgvpKEBIlM1vCN8khTnGTD70j98lm3CQTgw/MBi1NAIqRwJ7tuKhwDgkf0EBEQlYJ0TzTs2unGJLOHBg/zhIRm70RRF2TlPQDLtWAk+WaCjWvxt2gaIREldYjDuFfWRg1y7UsdFdUZ7r/DXC4hJ70WHqWje1ecXrwgqB8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250576; h=Content-Type: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=md68lIGdSEtX/fdjEE9hpy5ztw1WO1te9qlqHlHS1Qo=; b=Fy4vOtywhSSpG7vT4GJ5k+IM2Nhy3QGjvNlcUC1LbDp12udF1Ce5srOik+eD3qKhGUcz16+nuUWcONopGWisnE0YWMyOXjSd4iXEHOh54Z78UAagoL8Y+TKi5NxrZlnDpFEdErzRThXwl1MEucVK+yfqT/UCDdfO5SB3mvpEwEA= 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 1706250576703682.3954829193361; Thu, 25 Jan 2024 22:29:36 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFh6-0005H2-Mf; Fri, 26 Jan 2024 01:28:05 -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 1rTFgx-0005Bo-D6 for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:56 -0500 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 1rTFgt-0001lI-Fl for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:53 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-353-QrMdDcFgMeCCSZO3kBZ_iA-1; Fri, 26 Jan 2024 01:27:46 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id EC6BC85A588; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CA12640C1430; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id B6D4C21E66F1; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250470; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=md68lIGdSEtX/fdjEE9hpy5ztw1WO1te9qlqHlHS1Qo=; b=GDBlId7CjZzg4SR/HLv9oTlbSImVPIMBMZ5GDDAqieEnWSeV9fQxfgD4Kw8FjqD8RwZjJQ FYkv3pXpPTmlMhwiDp/zew1+Mt4grqMBq9M+J+HMnojlleokyaakDuRiLsv9bJAJDm0Drf f7C+MvjRUJfHit439j8TqbrUpkVafX0= X-MC-Unique: QrMdDcFgMeCCSZO3kBZ_iA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 1/8] docs/devel/qapi-code-gen: Don't reserve types ending with 'Kind' Date: Fri, 26 Jan 2024 07:27:37 +0100 Message-ID: <20240126062744.265588-2-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.2 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: -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.5, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250578311100009 Content-Type: text/plain; charset="utf-8" We reserved type names ending with 'Kind' because a simple union 'SomeSimpleUnion' generated both a struct type SomeSimpleUnion and an enum type SomeSimpleUnionKind. Gone since commit 4e99f4b12c0 (qapi: Drop simple unions). The commit neglected to update the documentation not to reserve type names ending with 'Kind'. Do that now. Signed-off-by: Markus Armbruster Message-ID: <20231221145727.835905-1-armbru@redhat.com> Reviewed-by: Eric Blake --- docs/devel/qapi-code-gen.rst | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/devel/qapi-code-gen.rst b/docs/devel/qapi-code-gen.rst index ea8228518c..0c6f4201bc 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -737,9 +737,8 @@ Types, commands, and events share a common namespace. = Therefore, generally speaking, type definitions should always use CamelCase for user-defined type names, while built-in types are lowercase. =20 -Type names ending with ``Kind`` or ``List`` are reserved for the -generator, which uses them for implicit union enums and array types, -respectively. +Type names ending with ``List`` are reserved for the generator, which +uses them for array types. =20 Command names, member names within a type, and feature names should be all lower case with words separated by a hyphen. However, some --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250546; cv=none; d=zohomail.com; s=zohoarc; b=C0s4b/Axh7UG2KLr4N2eq9/j99blkLwGFB30U3ObwESEQKzPeh2kn2aKbjoB+HcQP158AKmjBACJ/gCZ4HlXU/VLgUCWqgM13vVpwT+iRWeoEiXnGXdm32OHWABpaB7bd2qihDJYHib2OpIQ54sJxM5jOMdMASar2a9+NA7zNQ0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250546; h=Content-Type: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=xhzfvfMj6uCHQKS7YdMaHDEK4Ml51BNHBWLblw2z7MY=; b=ILzJB34Dyr8JWk9jXWHpjTaED//peyMomaxxvUuVGvx3Vv3EIj6+I9VEFxJCVj1jLvLZGF3ORxcwsPt4Uxxy9YreuBpIhvHUvCKRboG2XIbbrNguVO9IskUXMmYAifue1DjTS1JDJi2br9UGhT9rn0SWMBLGHgKBduF7pI6Y8/4= 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 1706250545994961.319504483688; Thu, 25 Jan 2024 22:29:05 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFgy-0005Bq-6z; Fri, 26 Jan 2024 01:27:57 -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 1rTFgv-0005Be-GP for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:54 -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 1rTFgt-0001l7-CI for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:52 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-38-G8Ja1cg6O7GK9y6uwmxwxQ-1; Fri, 26 Jan 2024 01:27:46 -0500 Received: from smtp.corp.redhat.com (int-mx05.intmail.prod.int.rdu2.redhat.com [10.11.54.5]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id E9F8D1C06923; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id C9AFC5012; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id B9C9F21E6697; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250469; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=xhzfvfMj6uCHQKS7YdMaHDEK4Ml51BNHBWLblw2z7MY=; b=QUni/9m9JCOk5I+jruW2NzrfCr/k/O8v7WFkZkC28q/Xglomir1a2QZi3NhMtYjWtgfqR9 hfrD+s3hmuo2sPXx2FzMcYAXHCKoFK2YP35qwxPAUcvRGdsIT0k+zFfN+3PTX8ruTb9SxG 8tuQ1rYwY1S5yRNm5b0GIuqsNfJRHkw= X-MC-Unique: G8Ja1cg6O7GK9y6uwmxwxQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 2/8] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs Date: Fri, 26 Jan 2024 07:27:38 +0100 Message-ID: <20240126062744.265588-3-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.5 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=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.5, 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250546477100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-2-armbru@redhat.com> Reviewed-by: Eric Blake --- 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 0c6f4201bc..76be722f4c 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -989,8 +989,8 @@ this:: # @feature: Description text =20 A tagged section starts with one of the following words: -"Note:"/"Notes:", "Since:", "Example"/"Examples", "Returns:", "TODO:". -The section ends with the start of a new section. +"Note:"/"Notes:", "Since:", "Example:"/"Examples:", "Returns:", +"TODO:". The section ends with the start of a new section. =20 The second and subsequent lines of sections other than "Example"/"Examples" should be indented like this:: --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250554; cv=none; d=zohomail.com; s=zohoarc; b=RGmeCdgCRzaLq5KdqdVIphvSSbYUVmMgeZs3L2YWadh4GDNncBpiVPKdrNajL8FLLx8zsduusTdWgq5wa7EVucJvkdaIcDRSmwDpvgz8XWcB57YZJpqaLUStDDiBlqJMGwK4rMl7BQcZ4o4Njnv/aWYa2je8aJrzFKtnWi2DLPI= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250554; h=Content-Type: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=VXw48Z1gqb2OkeP2X3gYVnL+yU4lWWOVRa93Cz5SFvQ=; b=S1GjCMrQ8sPABkhgMTeVSneRTJo9RrQlDyIBRsePjp9c76h25cV7AyGbRvcmDJ+Wt74F0a+ENKhlujVUKQfTzcwjE2RGGtpLFLqWue49uY9pdStDZRdSjgep5NyUJMaXgXB6JRNwQ8JK8hatiL0NwQJawdRDiT4wScpWK4vXPMI= 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 1706250554536920.0894057616973; Thu, 25 Jan 2024 22:29:14 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFh3-0005FO-Ht; Fri, 26 Jan 2024 01:28:02 -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 1rTFgx-0005Bp-DL for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:56 -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 1rTFgt-0001lB-HR for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:54 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-326-E2Hx8QeHPiqPlLPXIn8G0Q-1; Fri, 26 Jan 2024 01:27:46 -0500 Received: from smtp.corp.redhat.com (int-mx07.intmail.prod.int.rdu2.redhat.com [10.11.54.7]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id EDAFA185A781; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CB2901C060B1; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BCB2321E669B; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250470; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=VXw48Z1gqb2OkeP2X3gYVnL+yU4lWWOVRa93Cz5SFvQ=; b=ZbzyTOBAQsYaXAMEeBEBMLCEk4rWoT/Xc7A6mBeONseW2YZKZvdPUVIxc5qhKkj7+L2SZM kvTZqFeX41wzsAnwP0kHUTXqQPVGkxEnNJox0m2bLEGfMrfiiy09c4P55Pf7IfW0q/TKVg ipEQZM8l28zlqMV77gcU2KPBVSHyRPE= X-MC-Unique: E2Hx8QeHPiqPlLPXIn8G0Q-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 3/8] docs: Replace dangling references to docs/interop/qmp-intro.txt Date: Fri, 26 Jan 2024 07:27:39 +0100 Message-ID: <20240126062744.265588-4-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.7 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=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.5, 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250556326100001 Content-Type: text/plain; charset="utf-8" Deletion of docs/interop/qmp-intro.txt left two dangling references behind. Replace them by references to docs/interop/qmp-spec.rst. Fixes: 0ec4468f233c (docs/interop: Delete qmp-intro.txt) Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-3-armbru@redhat.com> Reviewed-by: Eric Blake --- docs/devel/writing-monitor-commands.rst | 4 ++-- docs/interop/bitmaps.rst | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/devel/writing-monitor-commands.rst b/docs/devel/writing-m= onitor-commands.rst index 2c11e71665..3b3d5517a2 100644 --- a/docs/devel/writing-monitor-commands.rst +++ b/docs/devel/writing-monitor-commands.rst @@ -8,8 +8,8 @@ This document doesn't discuss QMP protocol level details, n= or does it dive into the QAPI framework implementation. =20 For an in-depth introduction to the QAPI framework, please refer to -docs/devel/qapi-code-gen.txt. For documentation about the QMP protocol, -start with docs/interop/qmp-intro.txt. +docs/devel/qapi-code-gen.txt. For the QMP protocol, see the +:doc:`/interop/qmp-spec`. =20 New commands may be implemented in QMP only. New HMP commands should be implemented on top of QMP. The typical HMP command wraps around an diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst index 1de46febdc..c731be2f01 100644 --- a/docs/interop/bitmaps.rst +++ b/docs/interop/bitmaps.rst @@ -166,9 +166,9 @@ Basic QMP Usage --------------- =20 The primary interface to manipulating bitmap objects is via the QMP -interface. If you are not familiar, see docs/interop/qmp-intro.txt for a b= road -overview, and `qemu-qmp-ref `_ for a full reference of = all -QMP commands. +interface. If you are not familiar, see the :doc:`qmp-spec` for the +protocol, and `qemu-qmp-ref `_ for a full +reference of all QMP commands. =20 Supported Commands ~~~~~~~~~~~~~~~~~~ --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250576; cv=none; d=zohomail.com; s=zohoarc; b=kPdP3DFTtyR7hDoTnE7GA8mYhOZPse4sllgm1VwXtBYl8dn4l5A6cIf34T60qLExf2pEZBkA7BVaapZ7madROgvvuWLpNAlqxb+/JA0d08dQdyUOCBisofagtrPK5uTo5/s/SmVHfTjTzpUwf2PmR7Kn85kuecrvBqtNRTpn3XE= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250576; h=Content-Type: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=FYew2ZaKFKV5e/lU7WHbyqAminN3XCJGghGyAxhULiU=; b=DyYVs6Dowo9TcQPg8qzr7fF//mpFOOLGfUXoSsJlWoq6L8NKbDZrsz/ZVLWZ5EsmuNZDfb2A321ceAfOQ+W8ZAbWia5xUP97B3S94dK217qr5ieAQ2XE3FbQxYKednUpBWtm3IUfWgXQxlbR9DJuQo/Zk8rk7iWarxwnKlt48LM= 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 17062505767651011.923896930463; Thu, 25 Jan 2024 22:29:36 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFhA-0005Ke-2U; Fri, 26 Jan 2024 01:28:08 -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 1rTFgz-0005Ce-Ck for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:58 -0500 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 1rTFgt-0001ki-H0 for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:55 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-681-VEuHcVvqOmqg_0aw_MHIbQ-1; Fri, 26 Jan 2024 01:27:46 -0500 Received: from smtp.corp.redhat.com (int-mx09.intmail.prod.int.rdu2.redhat.com [10.11.54.9]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 1485B1C06929; Fri, 26 Jan 2024 06:27:46 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id CA4B1492BC6; Fri, 26 Jan 2024 06:27:45 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id BF8A421E65C3; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250467; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=FYew2ZaKFKV5e/lU7WHbyqAminN3XCJGghGyAxhULiU=; b=Aui2AZdPkIeaBXod+AO/93rjFdQJxAH3qT5HCL0Ab3gzBoPBivvOj4fTFCFBP3/9EuimHP 22NQKn3dTgsfh6K/6n3szCLFwj4RM1IKHKwVrlaTgm4/PHej3GL90fZ3iCP8UrDRsE4GjD oZMNpFLaW5FKZZev8vwYdvTRIVdcvVI= X-MC-Unique: VEuHcVvqOmqg_0aw_MHIbQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 4/8] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt Date: Fri, 26 Jan 2024 07:27:40 +0100 Message-ID: <20240126062744.265588-5-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.9 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: -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.5, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250578315100010 Content-Type: text/plain; charset="utf-8" Conversion of docs/devel/qapi-code-gen.txt to ReST left several dangling references behind. Fix them to point to docs/devel/qapi-code-gen.rst. Fixes: f7aa076dbdfc (docs: convert qapi-code-gen.txt to ReST) Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-4-armbru@redhat.com> Reviewed-by: Eric Blake --- docs/devel/writing-monitor-commands.rst | 2 +- qapi/introspect.json | 4 ++-- include/qapi/visitor.h | 2 +- include/qemu/yank.h | 2 +- qapi/qapi-util.c | 2 +- util/yank.c | 2 +- scripts/qapi/parser.py | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/devel/writing-monitor-commands.rst b/docs/devel/writing-m= onitor-commands.rst index 3b3d5517a2..b6ee4fa063 100644 --- a/docs/devel/writing-monitor-commands.rst +++ b/docs/devel/writing-monitor-commands.rst @@ -8,7 +8,7 @@ This document doesn't discuss QMP protocol level details, n= or does it dive into the QAPI framework implementation. =20 For an in-depth introduction to the QAPI framework, please refer to -docs/devel/qapi-code-gen.txt. For the QMP protocol, see the +:doc:`qapi-code-gen`. For the QMP protocol, see the :doc:`/interop/qmp-spec`. =20 New commands may be implemented in QMP only. New HMP commands should be diff --git a/qapi/introspect.json b/qapi/introspect.json index 9173e60fdd..ebc4e199d2 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -260,8 +260,8 @@ # Additional SchemaInfo members for meta-type 'alternate'. # # @members: the alternate type's members, in no particular order. The -# members' wire encoding is distinct, see -# docs/devel/qapi-code-gen.txt section Alternate types. +# members' wire encoding is distinct, see :doc:`qapi-code-gen` +# section Alternate types. # # On the wire, this can be any of the members. # diff --git a/include/qapi/visitor.h b/include/qapi/visitor.h index d53a84c9ba..27b85d4700 100644 --- a/include/qapi/visitor.h +++ b/include/qapi/visitor.h @@ -39,7 +39,7 @@ * limitations; see the documentation for each visitor for more * details on what it supports. Also, see visitor-impl.h for the * callback contracts implemented by each visitor, and - * docs/devel/qapi-code-gen.txt for more about the QAPI code + * docs/devel/qapi-code-gen.rst for more about the QAPI code * generator. * * All of the visitors are created via: diff --git a/include/qemu/yank.h b/include/qemu/yank.h index 1907150933..3d88af6996 100644 --- a/include/qemu/yank.h +++ b/include/qemu/yank.h @@ -45,7 +45,7 @@ void yank_unregister_instance(const YankInstance *instanc= e); * yank_register_function: Register a yank function * * This registers a yank function. All limitations of qmp oob commands app= ly - * to the yank function as well. See docs/devel/qapi-code-gen.txt under + * to the yank function as well. See docs/devel/qapi-code-gen.rst under * "An OOB-capable command handler must satisfy the following conditions". * * This function is thread-safe. diff --git a/qapi/qapi-util.c b/qapi/qapi-util.c index 63596e11c5..65a7d18437 100644 --- a/qapi/qapi-util.c +++ b/qapi/qapi-util.c @@ -112,7 +112,7 @@ bool qapi_bool_parse(const char *name, const char *valu= e, bool *obj, Error **err * It may be prefixed by __RFQDN_ (downstream extension), where RFQDN * may contain only letters, digits, hyphen and period. * The special exception for enumeration names is not implemented. - * See docs/devel/qapi-code-gen.txt for more on QAPI naming rules. + * See docs/devel/qapi-code-gen.rst for more on QAPI naming rules. * Keep this consistent with scripts/qapi-gen.py! * If @complete, the parse fails unless it consumes @str completely. * Return its length on success, -1 on failure. diff --git a/util/yank.c b/util/yank.c index abf47c346d..eaac50539c 100644 --- a/util/yank.c +++ b/util/yank.c @@ -35,7 +35,7 @@ typedef struct YankInstanceEntry YankInstanceEntry; /* * This lock protects the yank_instance_list below. Because it's taken by * OOB-capable commands, it must be "fast", i.e. it may only be held for a - * bounded, short time. See docs/devel/qapi-code-gen.txt for additional + * bounded, short time. See docs/devel/qapi-code-gen.rst for additional * information. */ static QemuMutex yank_lock; diff --git a/scripts/qapi/parser.py b/scripts/qapi/parser.py index bf31018aef..48cd55a38c 100644 --- a/scripts/qapi/parser.py +++ b/scripts/qapi/parser.py @@ -71,7 +71,7 @@ class QAPISchemaParser: Parse QAPI schema source. =20 Parse a JSON-esque schema file and process directives. See - qapi-code-gen.txt section "Schema Syntax" for the exact syntax. + qapi-code-gen.rst section "Schema Syntax" for the exact syntax. Grammatical validation is handled later by `expr.check_exprs()`. =20 :param fname: Source file name. --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250590; cv=none; d=zohomail.com; s=zohoarc; b=fAI0CYfF0Gv0kn8cswn+3nqDWjLHhl98nGh59p7MSBIYvMhKsPLzmMVPj3T0SkAewrTV8oxyAwESnX+k88K1KB2f/6uVYC9v1/ULVr5cnPFUeLiBgGFZxwtunP74jkWBcPOjVdTmap3GHlaBXdlMn18Si2auO32pIW+Bw3TPOMo= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250590; h=Content-Type: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=2mmMYHvDQDN6OfF30okqxj2SQBKP3qYxdXo7byKEb24=; b=ieywN+foCq2mf9xsDkFRfdOKrTZfeq+X9SefL5T7zddyroE3rEIE6BpBZ5Ailn9eZ0MzK/NOb2XIQCpnD+8DlF6dXLfZcYbGvLKU1Dh9T+qKlvynzT/OZDAD7zNtmi7sc1vPrjCue4p9n5j5QaSn7tvD8wo/WtpdmtHRxxcW548= 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 1706250590505763.7383359586984; Thu, 25 Jan 2024 22:29:50 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFh8-0005IH-Nr; Fri, 26 Jan 2024 01:28:06 -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 1rTFgx-0005Bm-CD for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:56 -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 1rTFgt-0001l3-E1 for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:54 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-118-T76yXuIsN3SsP88DJmEK9Q-1; Fri, 26 Jan 2024 01:27:47 -0500 Received: from smtp.corp.redhat.com (int-mx02.intmail.prod.int.rdu2.redhat.com [10.11.54.2]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 3876C83B828; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 1752940C1430; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C27B121E64CB; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250469; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=2mmMYHvDQDN6OfF30okqxj2SQBKP3qYxdXo7byKEb24=; b=BYgS4Im88+ENCX7nZnq9PwUCudBguEIpO1YCk2qoJKkjqzrWc4VbktOxmjbBA1r1IuT2Qj P3+K2icA6QwR2Re5uFRH9CUczbpEs5GPNrEoWbTTGZIsYnYBV/2tzl6l+6QKs9Y29zf65H 11UFXpptBzTHEOGxIofXilXdvQVq5GI= X-MC-Unique: T76yXuIsN3SsP88DJmEK9Q-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 5/8] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Date: Fri, 26 Jan 2024 07:27:41 +0100 Message-ID: <20240126062744.265588-6-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.2 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=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.5, 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_H3=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250592334100003 Content-Type: text/plain; charset="utf-8" docs/interop/bitmaps.rst uses references like `qemu-qmp-ref `_ `query-block `_ to refer to and into docs/interop/qemu-qmp-ref.rst. Clean up the former: use :doc:`qemu-qmp-ref`. I don't know how to clean up the latter. Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-5-armbru@redhat.com> Reviewed-by: Eric Blake --- docs/interop/bitmaps.rst | 4 ++-- qapi/introspect.json | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/interop/bitmaps.rst b/docs/interop/bitmaps.rst index c731be2f01..ddf8947d54 100644 --- a/docs/interop/bitmaps.rst +++ b/docs/interop/bitmaps.rst @@ -167,8 +167,8 @@ Basic QMP Usage =20 The primary interface to manipulating bitmap objects is via the QMP interface. If you are not familiar, see the :doc:`qmp-spec` for the -protocol, and `qemu-qmp-ref `_ for a full -reference of all QMP commands. +protocol, and :doc:`qemu-qmp-ref` for a full reference of all QMP +commands. =20 Supported Commands ~~~~~~~~~~~~~~~~~~ diff --git a/qapi/introspect.json b/qapi/introspect.json index ebc4e199d2..8df1ce85ed 100644 --- a/qapi/introspect.json +++ b/qapi/introspect.json @@ -260,8 +260,8 @@ # Additional SchemaInfo members for meta-type 'alternate'. # # @members: the alternate type's members, in no particular order. The -# members' wire encoding is distinct, see :doc:`qapi-code-gen` -# section Alternate types. +# members' wire encoding is distinct, see +# :doc:`/devel/qapi-code-gen` section Alternate types. # # On the wire, this can be any of the members. # --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250544; cv=none; d=zohomail.com; s=zohoarc; b=gQbEarxIaMbvIhRAZeQdEjaG8PFqUZz871Bxw8XTBVAYxAHqEGjC1ALPXkQay2O6To7XYrz2j/POEDqA7oa2s0IM8XqDbfcynVqbIINQw0lu36vig1KevbiNNXs1hUK6OemUIdZahEiSU6vLh8Uh4deVPHYmAsE199ASSVjrzk4= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250544; h=Content-Type: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=ySQDf5g9/v0nPnqbT6JK80hLcsPNam4RWz2L61QyP7M=; b=GW+JeQHB4FTOCzKPcc0U1cvH8pOZIW4Gf20Vg97PysPsYHv+5MibL6ekIbMAsQ4C06EVo8aE1vP1JiwV8S5p0QzELXhd1sdKTG0erqsgCs8YYCYSOhP+OdRijxeeAeU2p7rqgcFtsZeXepl9pOxhXsNq8S/VQFfGhOkU80OzFds= 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 1706250544969988.2569602309934; Thu, 25 Jan 2024 22:29:04 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFhB-0005LE-BD; Fri, 26 Jan 2024 01:28:10 -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 1rTFgz-0005Cb-Ar for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:58 -0500 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 1rTFgv-0001lj-8W for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:55 -0500 Received: from mimecast-mx02.redhat.com (mx-ext.redhat.com [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-111-TKwtHDiIN7K_idxUrUT-KA-1; Fri, 26 Jan 2024 01:27:47 -0500 Received: from smtp.corp.redhat.com (int-mx03.intmail.prod.int.rdu2.redhat.com [10.11.54.3]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 397113C13A90; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 17BE61121313; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C54D521E64CD; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250472; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=ySQDf5g9/v0nPnqbT6JK80hLcsPNam4RWz2L61QyP7M=; b=XGQ8PIcydo9pRVM5QbU5v0qmKD0nOlQYj0hp4Fq+wR/8qCsAxf7g3CyhK9CfCwUIcKOGIT MFlvrnvgDKl7KCnzqqRKn43WfaPTn20T+/JGeQykoru68Tkyq9mkoBzY4IbXIv4bsyAofe dMvkTribqq81ALHPrNN3BvKXlgI9g6E= X-MC-Unique: TKwtHDiIN7K_idxUrUT-KA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 6/8] qapi: Fix mangled "Returns" sections in documentation Date: Fri, 26 Jan 2024 07:27:42 +0100 Message-ID: <20240126062744.265588-7-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.3 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: -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.5, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250546487100002 Content-Type: text/plain; charset="utf-8" Commit e050e426782e (qapi: Use explicit bulleted lists) added list markup to correct bad rendering: A JSON block comment like this: Returns: nothing on success If @node is not a valid block device, DeviceNotFound If @name is not found, GenericError with an explanation renders like this: Returns: nothing on success If node is not a valid block device, DeviceNotFound If name is not found, GenericError with an explanat= ion because whitespace is not significant. Use an actual bulleted list, so that the formatting is correct. It missed a few instances. Commit a937b6aa739 (qapi: Reformat doc comments to conform to current conventions) then reflowed them. Revert the reflowing, and add list markup. Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-6-armbru@redhat.com> Reviewed-by: Eric Blake --- qapi/net.json | 15 +++++++++------ qapi/qdev.json | 5 +++-- qapi/qom.json | 10 ++++++---- 3 files changed, 18 insertions(+), 12 deletions(-) diff --git a/qapi/net.json b/qapi/net.json index 8095b68fa8..68493d6ac9 100644 --- a/qapi/net.json +++ b/qapi/net.json @@ -18,8 +18,9 @@ # # @up: true to set the link status to be up # -# Returns: Nothing on success If @name is not a valid network device, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @name is not a valid network device, DeviceNotFound # # Since: 0.14 # @@ -44,8 +45,9 @@ # # Since: 0.14 # -# Returns: Nothing on success If @type is not a valid network backend, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @type is not a valid network backend, DeviceNotFound # # Example: # @@ -64,8 +66,9 @@ # # @id: the name of the network backend to remove # -# Returns: Nothing on success If @id is not a valid network backend, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @id is not a valid network backend, DeviceNotFound # # Since: 0.14 # diff --git a/qapi/qdev.json b/qapi/qdev.json index 6bc5a733b8..25bac5e611 100644 --- a/qapi/qdev.json +++ b/qapi/qdev.json @@ -89,8 +89,9 @@ # # @id: the device's ID or QOM path # -# Returns: Nothing on success If @id is not a valid device, -# DeviceNotFound +# Returns: +# - Nothing on success +# - If @id is not a valid device, DeviceNotFound # # Notes: When this command completes, the device may not be removed # from the guest. Hot removal is an operation that requires guest diff --git a/qapi/qom.json b/qapi/qom.json index 95516ba325..84af23fe24 100644 --- a/qapi/qom.json +++ b/qapi/qom.json @@ -1056,8 +1056,9 @@ # # Create a QOM object. # -# Returns: Nothing on success Error if @qom-type is not a valid class -# name +# Returns: +# - Nothing on success +# - Error if @qom-type is not a valid class name # # Since: 2.0 # @@ -1078,8 +1079,9 @@ # # @id: the name of the QOM object to remove # -# Returns: Nothing on success Error if @id is not a valid id for a QOM -# object +# Returns: +# - Nothing on success +# - Error if @id is not a valid id for a QOM object # # Since: 2.0 # --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250582; cv=none; d=zohomail.com; s=zohoarc; b=DZ9vIsIZe/0+pcbvXzR90z3lYpK8g4mF0JmE24TBnbF4Uae4R9nAFRxDubqomoNZvL2WgbQcjPzkAqsTSFPDqX9T3LaWsFOONHS7uItChZ5X8b6+GBSi5o4JlacavUwryB5MrpCDE+CrNKgAydynKdOg0UUcvYootwEW3+VMDeA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250582; h=Content-Type: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=PGX6mTbZvV1IOJ+Vc7ozbEGlpGGzvO1hyUMZSRhdwF8=; b=PhAlWXZHfu2Yl5+3gSEFOxPqFSrsi5F7NsGkcE0N5kkDIxMG7iYYtnTt7rn02x9umetferV6PAqSksjC0jYGnIk4GLOwe30Kma1FQWveAoctzry7K22gGeF5Fu20NpmuSCeDCyFr/zlCxwUC/JP3/ABpv4H5yvXsRYXQWSgltKU= 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 1706250582572349.98092180498077; Thu, 25 Jan 2024 22:29:42 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFhA-0005Kv-To; Fri, 26 Jan 2024 01:28:08 -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 1rTFgz-0005Cd-Cq for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:58 -0500 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 1rTFgu-0001ld-K7 for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:55 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-433-d0bvaY9kNY6kzpWRru7c0w-1; Fri, 26 Jan 2024 01:27:47 -0500 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 554D6185A783; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 181282166B32; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C85EB21E64D2; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250471; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=PGX6mTbZvV1IOJ+Vc7ozbEGlpGGzvO1hyUMZSRhdwF8=; b=jOurAZ0PpdD9yGU7naI6mz/eHNpVItB6pDGvsiZXusQeOshSzUTv4XHos/fLfnu2No2M88 N5M359yNn3qVf76qLB1q9vNue52UhTq1ViQK0fD3pbmHbXxp58U+Z7amYQnuF6a9DeK5it rD2JuZb54ohkHJ7wkjnJb+oZOidsdkw= X-MC-Unique: d0bvaY9kNY6kzpWRru7c0w-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, Eric Blake Subject: [PULL 7/8] qapi: Indent tagged doc comment sections properly Date: Fri, 26 Jan 2024 07:27:43 +0100 Message-ID: <20240126062744.265588-8-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.6 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: -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.5, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250584336100005 Content-Type: text/plain; charset="utf-8" docs/devel/qapi-code-gen demands that the "second and subsequent lines of sections other than "Example"/"Examples" should be indented". Commit a937b6aa739 (qapi: Reformat doc comments to conform to current conventions) missed a few instances, and a few more have crept in since. Indent them. Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-7-armbru@redhat.com> Reviewed-by: Eric Blake --- qapi/char.json | 4 ++-- qapi/machine.json | 24 ++++++++++++------------ qapi/misc-target.json | 2 +- qapi/misc.json | 10 +++++----- qapi/yank.json | 4 ++-- 5 files changed, 22 insertions(+), 22 deletions(-) diff --git a/qapi/char.json b/qapi/char.json index c1bab7b855..6c6ad3b10c 100644 --- a/qapi/char.json +++ b/qapi/char.json @@ -391,8 +391,8 @@ # @rows: console height, in chars # # Note: the options are only effective when the VNC or SDL graphical -# display backend is active. They are ignored with the GTK, Spice, VNC -# and D-Bus display backends. +# display backend is active. They are ignored with the GTK, +# Spice, VNC and D-Bus display backends. # # Since: 1.5 ## diff --git a/qapi/machine.json b/qapi/machine.json index b6d634b30d..aa99fa333f 100644 --- a/qapi/machine.json +++ b/qapi/machine.json @@ -1059,10 +1059,10 @@ # From it we have: balloon_size =3D vm_ram_size - @value # # Returns: -# - Nothing on success -# - If the balloon driver is enabled but not functional because the -# KVM kernel module cannot support it, KVMMissingCap -# - If no balloon device is present, DeviceNotActive +# - Nothing on success +# - If the balloon driver is enabled but not functional because +# the KVM kernel module cannot support it, KVMMissingCap +# - If no balloon device is present, DeviceNotActive # # Notes: This command just issues a request to the guest. When it # returns, the balloon size may not have changed. A guest can @@ -1097,10 +1097,10 @@ # Return information about the balloon device. # # Returns: -# - @BalloonInfo on success -# - If the balloon driver is enabled but not functional because the -# KVM kernel module cannot support it, KVMMissingCap -# - If no balloon device is present, DeviceNotActive +# - @BalloonInfo on success +# - If the balloon driver is enabled but not functional because +# the KVM kernel module cannot support it, KVMMissingCap +# - If no balloon device is present, DeviceNotActive # # Since: 0.14 # @@ -1161,10 +1161,10 @@ # message from the guest. # # Returns: -# - @HvBalloonInfo on success -# - If no hv-balloon device is present, guest memory status reporting -# is not enabled or no guest memory status report received yet, -# GenericError +# - @HvBalloonInfo on success +# - If no hv-balloon device is present, guest memory status +# reporting is not enabled or no guest memory status report +# received yet, GenericError # # Since: 8.2 # diff --git a/qapi/misc-target.json b/qapi/misc-target.json index 88291453ba..9195e7d26b 100644 --- a/qapi/misc-target.json +++ b/qapi/misc-target.json @@ -475,7 +475,7 @@ # @port: The port number # # Returns: -# - Nothing on success. +# - Nothing on success. # # Since: 8.0 # diff --git a/qapi/misc.json b/qapi/misc.json index 3622d98d01..2ca8c39874 100644 --- a/qapi/misc.json +++ b/qapi/misc.json @@ -344,9 +344,9 @@ # @opaque: A free-form string that can be used to describe the fd. # # Returns: -# - @AddfdInfo on success -# - If file descriptor was not received, GenericError -# - If @fdset-id is a negative value, GenericError +# - @AddfdInfo on success +# - If file descriptor was not received, GenericError +# - If @fdset-id is a negative value, GenericError # # Notes: The list of fd sets is shared by all monitor connections. # @@ -374,8 +374,8 @@ # @fd: The file descriptor that is to be removed. # # Returns: -# - Nothing on success -# - If @fdset-id or @fd is not found, GenericError +# - Nothing on success +# - If @fdset-id or @fd is not found, GenericError # # Since: 1.2 # diff --git a/qapi/yank.json b/qapi/yank.json index 87ec7cab96..60eda20816 100644 --- a/qapi/yank.json +++ b/qapi/yank.json @@ -77,8 +77,8 @@ # Takes a list of @YankInstance as argument. # # Returns: -# - Nothing on success -# - @DeviceNotFound error, if any of the YankInstances doesn't exist +# - Nothing on success +# - @DeviceNotFound error, if any of the YankInstances doesn't exist # # Example: # --=20 2.43.0 From nobody Tue Nov 26 14:37:12 2024 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=1706250574; cv=none; d=zohomail.com; s=zohoarc; b=HtRz33dLNujZJlz7p1esb59K538TeHtYSnQo7huonNg6xkM2MpSWsLoWOEx/GS9O22iMXQhYihpQ6wINWyf+teNi3Sc0+RGdWwbOqs90Oc05Pe0F6E+9879iNVZDvnwxxPAU3+QXDBuNRpL8GRCX6kU0PW3D7mnaxN2hbjH0p+M= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1706250574; h=Content-Type: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=Cp8ZxzKkqZpsj6SYD+QlYEtdgZx10sRCQ+x/2og0xPs=; b=Ctmo9vwP517RcuZpqBPodDkqXrjPtESsAUKzJWH/X7Vg5Yu0Cxal0EHujdp4QWpN8ANIyQWYb3JYuoEB9BKaA7K/sZGIgO/g1Ip9c7IIG6BeXrleObWYdQJqeLSG0o1Y8ZsOZ9iKP7t4vrgI9hXkNjiyIMWON76I0lZyf9cp+Dg= 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 1706250574622824.5309860665229; Thu, 25 Jan 2024 22:29:34 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rTFh7-0005Hi-Vb; Fri, 26 Jan 2024 01:28:06 -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 1rTFgx-0005Bn-Cj for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:56 -0500 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 1rTFgt-0001l0-EN for qemu-devel@nongnu.org; Fri, 26 Jan 2024 01:27:54 -0500 Received: from mimecast-mx02.redhat.com (mimecast-mx02.redhat.com [66.187.233.88]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-691-OSzW6yY-M7aUAP_rD7smIw-1; Fri, 26 Jan 2024 01:27:47 -0500 Received: from smtp.corp.redhat.com (int-mx04.intmail.prod.int.rdu2.redhat.com [10.11.54.4]) (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 mimecast-mx02.redhat.com (Postfix) with ESMTPS id 38F0983B82A; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.123]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 172D9200A08E; Fri, 26 Jan 2024 06:27:47 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id CB5DD21E64DA; Fri, 26 Jan 2024 07:27:44 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1706250469; 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: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=Cp8ZxzKkqZpsj6SYD+QlYEtdgZx10sRCQ+x/2og0xPs=; b=TdXa9V7/gNhvcPPM8KULi2iM97FJUlDrdKvGuFMo7uCe/r/9yi8BFERuJZXiCqlR6vrWGb W/KGIsBlpEIuh+qcL1f81m0F5cRjLksIW9Ak5hzgRxFyoH7z5rlevbdGisZnHmUMBmH3rn 0NOn2Rg24pwPb01YwPPn4S8b6Kj+ZXY= X-MC-Unique: OSzW6yY-M7aUAP_rD7smIw-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: peter.maydell@linaro.org, =?UTF-8?q?Philippe=20Mathieu-Daud=C3=A9?= , Eric Blake Subject: [PULL 8/8] qapi: Fix malformed "Since:" section tags (again) Date: Fri, 26 Jan 2024 07:27:44 +0100 Message-ID: <20240126062744.265588-9-armbru@redhat.com> In-Reply-To: <20240126062744.265588-1-armbru@redhat.com> References: <20240126062744.265588-1-armbru@redhat.com> MIME-Version: 1.0 Content-Type: text/plain; charset="utf-8" Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.4.1 on 10.11.54.4 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: -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.5, 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_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001, T_SCC_BODY_TEXT_LINE=-0.01 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: 1706250576314100001 "Since X.Y" is not recognized as a tagged section, and therefore not formatted as such in generated documentation. Fix by adding the required colon. Previously fixed in commit 433a4fdc420 (qapi: Fix malformed "Since:" section tags) Signed-off-by: Markus Armbruster Message-ID: <20240120095327.666239-8-armbru@redhat.com> Reviewed-by: Philippe Mathieu-Daud=C3=A9 Reviewed-by: Eric Blake --- qapi/block-core.json | 4 ++-- qapi/migration.json | 14 +++++++------- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/qapi/block-core.json b/qapi/block-core.json index ca390c5700..3919156d49 100644 --- a/qapi/block-core.json +++ b/qapi/block-core.json @@ -1361,7 +1361,7 @@ # target, i.e. same data and new writes are done synchronously to # both. # -# Since 8.2 +# Since: 8.2 ## { 'struct': 'BlockJobInfoMirror', 'data': { 'actively-synced': 'bool' } } @@ -3080,7 +3080,7 @@ # # @type: The job type # -# Since 8.2 +# Since: 8.2 ## { 'union': 'BlockJobChangeOptions', 'base': { 'id': 'str', 'type': 'JobType' }, diff --git a/qapi/migration.json b/qapi/migration.json index eb2f883513..489b591c23 100644 --- a/qapi/migration.json +++ b/qapi/migration.json @@ -1597,7 +1597,7 @@ # # @file: Direct the migration stream to a file. # -# Since 8.2 +# Since: 8.2 ## { 'enum': 'MigrationAddressType', 'data': [ 'socket', 'exec', 'rdma', 'file' ] } @@ -1609,7 +1609,7 @@ # # @offset: The file offset where the migration stream will start # -# Since 8.2 +# Since: 8.2 ## { 'struct': 'FileMigrationArgs', 'data': { 'filename': 'str', @@ -1620,7 +1620,7 @@ # # @args: command (list head) and arguments to execute. # -# Since 8.2 +# Since: 8.2 ## { 'struct': 'MigrationExecCommand', 'data': {'args': [ 'str' ] } } @@ -1630,7 +1630,7 @@ # # Migration endpoint configuration. # -# Since 8.2 +# Since: 8.2 ## { 'union': 'MigrationAddress', 'base': { 'transport' : 'MigrationAddressType'}, @@ -1648,7 +1648,7 @@ # # @main: Main outbound migration channel. # -# Since 8.1 +# Since: 8.1 ## { 'enum': 'MigrationChannelType', 'data': [ 'main' ] } @@ -1662,7 +1662,7 @@ # # @addr: Migration endpoint configuration on destination interface. # -# Since 8.1 +# Since: 8.1 ## { 'struct': 'MigrationChannel', 'data': { @@ -2126,7 +2126,7 @@ # # @millisecond: value is in milliseconds # -# Since 8.2 +# Since: 8.2 # ## { 'enum': 'TimeUnit', --=20 2.43.0