From nobody Tue Nov 26 17:21:32 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=1705744500; cv=none; d=zohomail.com; s=zohoarc; b=cR5iuFYC6s35+HKp2ofvO9X0lTHcKOehzQ4FAYUL12FbLF1s9iXuP1RxNeWrMddPHyxgWFgwPXaKRadDKZ96NbUMKjc4zEe0X28k9UcVLhd8IGGF79mDmvu47VqOTQ3apngfge++yjb1b1JdPLtRx3NhDzWivaZRNqZ9mFWevw8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744500; 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=Iliy3+gtCPH1+dZ+TyTmYGv3aXbJnlYxp8Fiob5GDRA=; b=dy729jWXbB252B2p7hdmLKtehY5l+XeKlivPXhnvhWCnvvPLgBj6foa6a4vVdxQ+VoEYukK3VYxCLxuh9xeU2arrqiHrWeOl/aUBdSFM26/DsSonJBpMdfIZFNzJMtQAanTLPnF2JAMkmkCvje1IOoRAJxfWU2QUsXsTve7maes= 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 170574450045912.864910192333014; Sat, 20 Jan 2024 01:55:00 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82l-00082o-J0; Sat, 20 Jan 2024 04:53:39 -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 1rR82j-000811-I0 for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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 1rR82h-00062x-18 for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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-584-yMx6bDI7M028Z98w3TuuzQ-1; Sat, 20 Jan 2024 04:53:28 -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 985B229AC032; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 7350540C6EBA; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5515421E66F4; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744413; 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=Iliy3+gtCPH1+dZ+TyTmYGv3aXbJnlYxp8Fiob5GDRA=; b=A+csBPJqiU+JIr+3pmd4CuAJpIC8YyNdlBfK6iN6iDfPG7RSaQRnJVdYb/VERg7AJ469M1 RGicHzU01IGw5XmAfYDhWrmNN3j3sW7Mz/Y01UJuq/nMxYlKHwa+3tKuQPuVFrC2PwGBWW KFzItgdDSmkAX7oHBu77KR1wiSmuAyw= X-MC-Unique: yMx6bDI7M028Z98w3TuuzQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 1/7] docs/devel/qapi-code-gen: Fix missing ':' in tagged section docs Date: Sat, 20 Jan 2024 10:53:21 +0100 Message-ID: <20240120095327.666239-2-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-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: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744501786100001 Content-Type: text/plain; charset="utf-8" Signed-off-by: Markus Armbruster 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 ea8228518c..899c16adf3 100644 --- a/docs/devel/qapi-code-gen.rst +++ b/docs/devel/qapi-code-gen.rst @@ -990,8 +990,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 17:21:32 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=1705744512; cv=none; d=zohomail.com; s=zohoarc; b=OqigRoAfp9qb9rXVd5kX/BWsIyZiuPMRQ2KoJ8uxGbExWLd5iqScE0Ywxr4Xajooinn96eND4oyQxs7RlhT5v16bx/FBu/4WzNCcopwbtEOUwKio5d79XS2FE+TBhABNtCMfC+t1VBhJxvDJbfUqU7qqvteMHDL7ooolNYqCzLk= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744512; 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=EkcAOlIpsHu3Yk36ORmBRWTDHkhZ5CeYfkZ72QQhXvQ=; b=Keend3b9yMjtmUBeIiX7Z6povPh9odKgui1pkoeMy9K2eTLgDSHdShD1nM9aJItqpgwzG1jJbFe06So1OHQ2dkcATvme/xYqiIgNVp5IRCYo63gbpwGLwPGdanUM6nP9oQjt8aeBvgRRe83udD+RPQnXfOEMlQjC2xBImvr63yA= 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 1705744512263193.21794551247024; Sat, 20 Jan 2024 01:55:12 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82j-00080r-5J; Sat, 20 Jan 2024 04:53: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 1rR82i-00080a-7S for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:36 -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 1rR82g-00062q-DN for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:35 -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-221-A4pV4eMYMwCx3IF1GYCf2A-1; Sat, 20 Jan 2024 04:53:28 -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 9801185A589; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 7339051D5; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 556D121E66F9; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744412; 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=EkcAOlIpsHu3Yk36ORmBRWTDHkhZ5CeYfkZ72QQhXvQ=; b=EaNA/tqFkKIXX2nDT7zoUWsDg7rp5eyzHhicsQbg7Jx6SH9buE67HDCcNUuUttzzd06ygV tDNh5Qn+1L9JD9o2rxtQ98IWcs+xZKjdOH5Y+TPXXwlu4Qo1R8Nkb+buIqjS2lCWjXW0Ov EORpKt6ZEoSAKtPwNo1DbwXlzJPgvbI= X-MC-Unique: A4pV4eMYMwCx3IF1GYCf2A-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 2/7] docs: Replace dangling references to docs/interop/qmp-intro.txt Date: Sat, 20 Jan 2024 10:53:22 +0100 Message-ID: <20240120095327.666239-3-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-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.129.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744513827100001 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 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 17:21:32 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=1705744455; cv=none; d=zohomail.com; s=zohoarc; b=X3jDKoGGWgQ//5FNw010CDMVGElihh3dFjEt51fuHH+zhyWvplfbCctmsOQZtoE2RfBRk7E9Z/r6nR1F7LexH7Gs/8qZsJm6nf7HGZ0OnG9a0HaWbP/kAQ0YDHunReYCiwGmGOytkEigmPS3nWlrj8QWB5v+k49PFW3QMj2yr+8= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744455; 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=OPjvbtvG4s60pZA7OovXeTzYsB0aBIBak1bvGdJ+5xQ=; b=hiUOGxIw1YBzzZMT7imZJggVxyJ5nG0TDdn6gCcsS/KoEJZ/xicCfzZIouvObR9yYN8yxLnwV3knvwqvwbR4hkeaBnQG3rI6eui48td8a2jpWvSbyR6rnQvwMU3tCr0jjUm9KccS3954o7sddj9r2+/K7fFJDB8FY5v5IcZ0eaA= 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 1705744455947662.9191247435001; Sat, 20 Jan 2024 01:54:15 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82k-00081k-3L; Sat, 20 Jan 2024 04:53:38 -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 1rR82i-00080Z-6c for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:36 -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 1rR82g-000633-DF for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:35 -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-392-_IOdWkFJMXCYJYWkXCFNrQ-1; Sat, 20 Jan 2024 04:53:29 -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 B3DC729AC033; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 736592166B33; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5841F21E66FB; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744413; 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=OPjvbtvG4s60pZA7OovXeTzYsB0aBIBak1bvGdJ+5xQ=; b=Rh7+N8IBhQaaLf/QjrssNMN6kS2N20cAi4CrpQxkSuM9Nz31Lle8ModW8AtZvrCLFmLSuC HJzSUpk83hJH1xu0HossRPUqkUAvB90uT8HhSqVa6onXG2vez4pqVevKyXFhKspWarB8Tk nnCkE2BVu/YOBeNkGIjgc38+ZcuefSg= X-MC-Unique: _IOdWkFJMXCYJYWkXCFNrQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 3/7] qapi: Fix dangling references to docs/devel/qapi-code-gen.txt Date: Sat, 20 Jan 2024 10:53:23 +0100 Message-ID: <20240120095327.666239-4-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744457957100001 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 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 17:21:32 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=1705744515; cv=none; d=zohomail.com; s=zohoarc; b=KuXznqe4pAzw05SS1yR4aQrHoF+w7uvhKW11/iEeCmXsemQF5wDiWdOo8/ekkoPZE1QPL8YTnMr0q5nCruA5ebSGRlkcBJPNphzhUVrCpSjN9Ol9ZHBgGlIk/WOHQjH7HvfIzSKjuRmuDTq19t8ghRulDh8ydS+NqW4W6/R1J0s= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744515; 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=FQA1DRO6iI9twls7npaDRRxrXTtaWLpraltdDpbY+9A=; b=lXoWyjP2A0u5bYql0UMOcRIxPTLnLB2Kfx4rkT7CggdDf5Q3uzoFNVD2BVdOilwLucfXI99uRJiaz8gJICcS1siotn9lWzkXZDh1s1mW/oUoqtDAfaifMkMUPdvJaYSnDNpGqy2DiBALqVR5imSjSeloSTMiJN4t6WH9sHruUCY= 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 1705744515710152.88687479534974; Sat, 20 Jan 2024 01:55:15 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82m-00083J-Ub; Sat, 20 Jan 2024 04:53:40 -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 1rR82k-00082J-Ob for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:38 -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 1rR82h-00063J-22 for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:38 -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-245-S_H-PmVbPyeWqokdtRA0KA-1; Sat, 20 Jan 2024 04:53:29 -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 9A2BC1C06D06; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id 736742166B35; Sat, 20 Jan 2024 09:53:28 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5B2A021E6682; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744414; 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=FQA1DRO6iI9twls7npaDRRxrXTtaWLpraltdDpbY+9A=; b=fMoL+QMwz9F2ZStexUF93RPlSpOycgP2QgoVHjqPTKsKAOPy6wm5ns+7bEHRGMymQnRZsv JTQgwieV89Lm911zLHgNZyFe9ClLR4TVe2N/W2P7N3T5hmefm/c/qzwUEvb9VX7ldUM00H i/bOqlZiqis+JSCQopbU5P/Msf+hkcs= X-MC-Unique: S_H-PmVbPyeWqokdtRA0KA-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 4/7] docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref Date: Sat, 20 Jan 2024 10:53:24 +0100 Message-ID: <20240120095327.666239-5-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-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: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744517828100009 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 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 17:21:32 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=1705744487; cv=none; d=zohomail.com; s=zohoarc; b=EsZ/nQDiU7pjo1YSY15+88JoqfQaM9KODISIpDMFpRdVBdN/XelfYNcJfHw4bezuv57Y9H+5CiMQ5E47uzzE+dH6i8KgPfMtlA6JM6FCtrxBLFhgOkkZqhuEeQC2gOmQX/usJGhVPdaAnKRcqPof27PB+OKheaBmDqQoyGb8ZlM= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744487; 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=8zMUZLz6aZ4QhMcvIy31bzbpBMATn24NCuvAj97hayc=; b=NTTbWOXp76hNshJ39UVZjlAomXq+pbuB8a9u2w0SF9BB+W3w2JzZ2ax8i0KzWW2hIsuq+7NRZkwUbLYx8+qNfKxorI1euLJC0XrRsTjtZqj08O7Qd+c728Lft6fnxsK0Uv7KNpP5T14SeT75UgFr+TCSB+LLw2iUegrrPyU6s4w= 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 1705744487699599.9542335807388; Sat, 20 Jan 2024 01:54:47 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82l-00082s-L7; Sat, 20 Jan 2024 04:53:39 -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 1rR82j-00081B-JK for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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 1rR82g-00062n-DQ for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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-307-f5XGsUK5OsG-EpFvFBYEVQ-1; Sat, 20 Jan 2024 04:53:30 -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 D482838143A3; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B3C7C2026D66; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 5E2FE21E6691; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744412; 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=8zMUZLz6aZ4QhMcvIy31bzbpBMATn24NCuvAj97hayc=; b=JLNbwhVHNNGoz87aYCKQaYJEuPzZswBEpBok6DGQFlbS7Uv+V7+VWLTAWtxTWgRimMzh7W oLTOsvqJ5EmxAzeYPyKRldKR/6RcyJpYwzPgxOnw5KUM6KrfSofhJKVmx3UWsUY7LZPZds dfXLsZRcy4HICFXsgNML0xS9zUecRGI= X-MC-Unique: f5XGsUK5OsG-EpFvFBYEVQ-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 5/7] qapi: Fix mangled "Returns" sections in documentation Date: Sat, 20 Jan 2024 10:53:25 +0100 Message-ID: <20240120095327.666239-6-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-1-armbru@redhat.com> MIME-Version: 1.0 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: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744489765100003 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 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 17:21:32 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=1705744515; cv=none; d=zohomail.com; s=zohoarc; b=PoLEQEvdnbujWr55yARMAvEXHWMbsIKnwiDdMtSCugPPxNPrqa1CbKd28yo7UKqj2KcGuxTzhKAtQoeiJkEquSLOKg1RDNf48Es0cyR4FsKhicLNgmOGSESIVjQKDVdbVPrOa10uK5s2mcgzb6MPcz0yvvNNV3B/cYOdfEKxVkA= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744515; 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=Y8RGbW2k8yCXApTfT7sSr7/FCzzhW9sTMtnFpEvy0Z4=; b=MgZGHKdACMWRYxlidnwIgilN4DcMZY0uh071hvnDBVwGgee1vQPTlY9pqwPpFHnytWL6EhulO4bVD8bdiKJo320dGynuOf/bYhFT7L8kPv15VfIbWisNxMNXEWCbzPXmGCwBXeK14nWR0w6/6gewUkKflIqKNSV/xV0ZZQKLGTE= 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 1705744515672689.85804320754; Sat, 20 Jan 2024 01:55:15 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82m-00083E-De; Sat, 20 Jan 2024 04:53:40 -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 1rR82j-00081O-Oz for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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 1rR82h-00063D-1c for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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-28-_4USKbRDPWuTyRSPf-0sHg-1; Sat, 20 Jan 2024 04:53:30 -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 F1D8A1066140; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B45C21C02EB3; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6127E21E660C; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744414; 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=Y8RGbW2k8yCXApTfT7sSr7/FCzzhW9sTMtnFpEvy0Z4=; b=PRspgrHrUPfcFS8vhhnmVs4LCR9VR+SjupAxjNJTvBylFLeNZ8ai+kDkUtJSGHVFU5Z77X 3CkxyZRmz2vQeZc+0T+pEzyqRBFDNIYz/xRfgsycIjpMkrIw3BmZGJD51Tpg4ScUUxrJHA fJcb7WHNhECTNVaBH3TS20eTgKCg70g= X-MC-Unique: _4USKbRDPWuTyRSPf-0sHg-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 6/7] qapi: Indent tagged doc comment sections properly Date: Sat, 20 Jan 2024 10:53:26 +0100 Message-ID: <20240120095327.666239-7-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-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: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744517836100010 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 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 17:21:32 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=1705744502; cv=none; d=zohomail.com; s=zohoarc; b=Ft9SaNxbNb7/mW5jhB6N5ELIXh1Fpb8waNmEqsbPzjJzMKb2SYTTFi7eormxsapTk9nGeuPRfWbm8Z7J2+e3AkhUTM3d3F/tGd5Df/HSa9o2HRU4Wd2EBdqIUPBeWaqUTeEpIOqYmzbuPRX+qUVZR3sKBTKqkD51w5n2dvdCXhQ= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1705744502; 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=2UT5EfYyaBjt6eTBspgfOokgyN/jy3NM7DNZlYf958A=; b=nHlXeuPRKcN/D6xxXUVy2O5zyyXR3lGHzaQdHpUhClyIPNWvc9gToqNXpJRGwI9/tRK4HJhG+ztkYlIyFkx6/GMA80ZhEFNgjXPANB5nXuxQbUsS4uWNOP+42eWAuB1XSQVRu01IK8TKcuai+TDLND5mwnlKk4QP3eb8mjicebM= 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 1705744502689443.37805795801137; Sat, 20 Jan 2024 01:55:02 -0800 (PST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rR82p-000845-NM; Sat, 20 Jan 2024 04:53:43 -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 1rR82j-00081C-KD for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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 1rR82g-000632-Gr for qemu-devel@nongnu.org; Sat, 20 Jan 2024 04:53:37 -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-28-8wcRV3mXOq-YHKqvl8Jl0w-1; Sat, 20 Jan 2024 04:53:30 -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 D5823800074; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.246]) by smtp.corp.redhat.com (Postfix) with ESMTPS id B419B492BC6; Sat, 20 Jan 2024 09:53:29 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id 6404E21E65C3; Sat, 20 Jan 2024 10:53:27 +0100 (CET) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1705744413; 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=2UT5EfYyaBjt6eTBspgfOokgyN/jy3NM7DNZlYf958A=; b=HzZRpcYxCCmPSdB0S/KLQz8UU23L5GUrWr2tJtLGIYPyT3iQpNtOwataj9BCKwsRdgOBYC KsB7Bcwi1bcsRTOkQVaNXTKL4pVOIYFO4Qy7sTcUzqItVUv5GCY86hkcADluF1bEx2j1QJ 8geUhcQLQ5fnGzJhImRl/YV+e74MNSg= X-MC-Unique: 8wcRV3mXOq-YHKqvl8Jl0w-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: michael.roth@amd.com, peter.maydell@linaro.org, jsnow@redhat.com Subject: [PATCH 7/7] qapi: Fix malformed "Since:" section tags (again) Date: Sat, 20 Jan 2024 10:53:27 +0100 Message-ID: <20240120095327.666239-8-armbru@redhat.com> In-Reply-To: <20240120095327.666239-1-armbru@redhat.com> References: <20240120095327.666239-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.133.124; envelope-from=armbru@redhat.com; helo=us-smtp-delivery-124.mimecast.com X-Spam_score_int: -45 X-Spam_score: -4.6 X-Spam_bar: ---- X-Spam_report: (-4.6 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-2.519, 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: 1705744503781100005 Content-Type: text/plain; charset="utf-8" "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 Reviewed-by: Eric Blake Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- 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