From nobody Sun Nov 24 19:36:19 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=1720697020; cv=none; d=zohomail.com; s=zohoarc; b=cLQ9dBbXEThbRJpVoYMT6zmY9Zdh79fdb+mQDdJrAllKwFejjGw8HBPge3LFNK/TaE8BcSva6mW+KFV2fpJVlgFfmRMH8M6FPqbopRCXq/EE+sY5nqQ4k5xDnPWGpVABMdACmtAYqIco+oUIZ7c2uInaMpuarJg9cB1ApLfBsBg= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1720697020; 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=tlY8XxdvjNE4b+PNvPu3Q90WCm87FDJnbmvPnGSRdCI=; b=M3Y3zYKt1m1wEwDjs9CSok1WxHgFeZJWlQP3fL7bAEDeBlGkljYmhaCM2mBSpqeP1r4+m688GDkYtl9t7qvjddKpB76FyowM+GhH7e1c6Z2piJWEL7X9fnBTXJFjbbSHT4/Jxv+t3+k61zdHTEUHbtmsv3Bd1RTIy2IrTplUZHg= 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 1720697020972963.1015761804526; Thu, 11 Jul 2024 04:23:40 -0700 (PDT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sRrsx-0001y4-ND; Thu, 11 Jul 2024 07:22:51 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sRrsw-0001x1-9g for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:50 -0400 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 1sRrsk-0000Hk-9K for qemu-devel@nongnu.org; Thu, 11 Jul 2024 07:22:49 -0400 Received: from mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (ec2-54-186-198-63.us-west-2.compute.amazonaws.com [54.186.198.63]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.3, cipher=TLS_AES_256_GCM_SHA384) id us-mta-662-i2YffhhyPZKwDwzjGLMh_A-1; Thu, 11 Jul 2024 07:22:33 -0400 Received: from mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com [10.30.177.40]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by mx-prod-mc-03.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id 27F16195420F; Thu, 11 Jul 2024 11:22:32 +0000 (UTC) Received: from blackfin.pond.sub.org (unknown [10.39.192.4]) by mx-prod-int-04.mail-002.prod.us-west-2.aws.redhat.com (Postfix) with ESMTPS id A3EFD19560AA; Thu, 11 Jul 2024 11:22:30 +0000 (UTC) Received: by blackfin.pond.sub.org (Postfix, from userid 1000) id C670421E65D1; Thu, 11 Jul 2024 13:22:28 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1720696955; 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=tlY8XxdvjNE4b+PNvPu3Q90WCm87FDJnbmvPnGSRdCI=; b=ars8oq9Os4mYtFYxppDCMvr94NW47JdvkR1Jf3thn7G3PBuPmk0kVQ6J3uFbi++w3d4Erg do+M+1se61V19qBWSAdHs0jy7GVEqGVAnq43egPyhdcXWwVYr0b0q5vt6N2I+bmkV4ps3x ePPjWSAPw+mVbVodfypuDPhOs26W9fA= X-MC-Unique: i2YffhhyPZKwDwzjGLMh_A-1 From: Markus Armbruster To: qemu-devel@nongnu.org Cc: eduardo@habkost.net, marcel.apfelbaum@gmail.com, philmd@linaro.org, wangyanan55@huawei.com, eblake@redhat.com, mst@redhat.com, berrange@redhat.com, marcandre.lureau@redhat.com, jsnow@redhat.com, imammedo@redhat.com Subject: [PATCH 4/5] qapi/sockets: Move deprecation note out of SocketAddress doc comment Date: Thu, 11 Jul 2024 13:22:27 +0200 Message-ID: <20240711112228.2140606-5-armbru@redhat.com> In-Reply-To: <20240711112228.2140606-1-armbru@redhat.com> References: <20240711112228.2140606-1-armbru@redhat.com> MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable X-Scanned-By: MIMEDefang 3.0 on 10.30.177.40 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: -21 X-Spam_score: -2.2 X-Spam_bar: -- X-Spam_report: (-2.2 / 5.0 requ) BAYES_00=-1.9, DKIMWL_WL_HIGH=-0.142, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: qemu-devel-bounces+importer=patchew.org@nongnu.org Sender: qemu-devel-bounces+importer=patchew.org@nongnu.org X-ZohoMail-DKIM: pass (identity @redhat.com) X-ZM-MESSAGEID: 1720697022010116600 Content-Type: text/plain; charset="utf-8" Doc comments are reference documentation for users of QMP. SocketAddress's doc comment contains a deprecation note advising developers to use SocketAddress for new code. Irrelevant for users of QMP. Move the note out of the doc comment. Signed-off-by: Markus Armbruster Reviewed-by: John Snow Reviewed-by: Philippe Mathieu-Daud=C3=A9 --- qapi/sockets.json | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/qapi/sockets.json b/qapi/sockets.json index 4d78d2ccb7..e76fdb9925 100644 --- a/qapi/sockets.json +++ b/qapi/sockets.json @@ -179,10 +179,6 @@ # # @type: Transport type # -# .. note:: This type is deprecated in favor of SocketAddress. The -# difference between SocketAddressLegacy and SocketAddress is that -# the latter has fewer ``{}`` on the wire. -# # Since: 1.3 ## { 'union': 'SocketAddressLegacy', @@ -193,6 +189,9 @@ 'unix': 'UnixSocketAddressWrapper', 'vsock': 'VsockSocketAddressWrapper', 'fd': 'FdSocketAddressWrapper' } } +# Note: This type is deprecated in favor of SocketAddress. The +# difference between SocketAddressLegacy and SocketAddress is that the +# latter has fewer ``{}`` on the wire. =20 ## # @SocketAddressType: --=20 2.45.0