From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id 9C0B242F6A; Fri, 28 Jul 2023 12:26:20 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 2855A40685; Fri, 28 Jul 2023 12:26:20 +0200 (CEST) Received: from us-smtp-delivery-124.mimecast.com (us-smtp-delivery-124.mimecast.com [170.10.129.124]) by mails.dpdk.org (Postfix) with ESMTP id 1531D4021E for ; Fri, 28 Jul 2023 12:26:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=redhat.com; s=mimecast20190719; t=1690539978; 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=tv0Ua/9Ts9g8mtLLw517da0wP7OlUT8d9s/hKPaRVow=; b=ivNGnbS7TjXBXnlscRYtpnrBZUYSHLmiv0gk1sJ6uF8QhxOLpAltJxXP/JmpsgMwb4FWgx 1p6oc1sx/qQq8GxVR/lA4fy2eaEL0QTETWW2DDpTBZVNeIqYnFxs43btcrFuebU+lKOPlZ 81MmJ7USFUDNKICX0wfPn7BaLhEGeOk= Received: from mimecast-mx02.redhat.com (66.187.233.73 [66.187.233.73]) by relay.mimecast.com with ESMTP with STARTTLS (version=TLSv1.2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id us-mta-683-STENDlIsPQuDkeq2KPXmdA-1; Fri, 28 Jul 2023 06:26:17 -0400 X-MC-Unique: STENDlIsPQuDkeq2KPXmdA-1 Received: from smtp.corp.redhat.com (int-mx06.intmail.prod.int.rdu2.redhat.com [10.11.54.6]) (using TLSv1.2 with cipher AECDH-AES256-SHA (256/256 bits)) (No client certificate requested) by mimecast-mx02.redhat.com (Postfix) with ESMTPS id B11B238117F9; Fri, 28 Jul 2023 10:26:16 +0000 (UTC) Received: from [10.39.208.22] (unknown [10.39.208.22]) by smtp.corp.redhat.com (Postfix) with ESMTPS id DA2952166B25; Fri, 28 Jul 2023 10:26:15 +0000 (UTC) Message-ID: <7eee75c5-4aab-fb26-900f-9898f8f61341@redhat.com> Date: Fri, 28 Jul 2023 12:26:14 +0200 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101 Thunderbird/102.13.0 Subject: Re: [PATCH v2] doc: announce deprecation of cmdline_poll To: Bruce Richardson , dev@dpdk.org Cc: Stephen Hemminger , Olivier Matz References: <20230314171858.67446-1-stephen@networkplumber.org> <20230728101542.59909-1-bruce.richardson@intel.com> From: Maxime Coquelin In-Reply-To: <20230728101542.59909-1-bruce.richardson@intel.com> X-Scanned-By: MIMEDefang 3.1 on 10.11.54.6 X-Mimecast-Spam-Score: 0 X-Mimecast-Originator: redhat.com Content-Language: en-US Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 7bit X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On 7/28/23 12:15, Bruce Richardson wrote: > From: Stephen Hemminger > > Function was added by commit 067855e651d6 ("cmdline: add polling mode") > but never tested or used by DPDK applications. Mark it for > future removal. > > Signed-off-by: Stephen Hemminger > Signed-off-by: Bruce Richardson > > --- > v2: Add deprecated tag to function and doxygen comment. > --- > doc/guides/rel_notes/deprecation.rst | 4 ++++ > lib/cmdline/cmdline.h | 3 +++ > 2 files changed, 7 insertions(+) > > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst > index fb771a0305..78d56a0ab4 100644 > --- a/doc/guides/rel_notes/deprecation.rst > +++ b/doc/guides/rel_notes/deprecation.rst > @@ -161,3 +161,7 @@ Deprecation Notices > The new port library API (functions rte_swx_port_*) > will gradually transition from experimental to stable status > starting with DPDK 23.07 release. > + > +* cmdline: The function ``cmdline_poll`` does not work correctly on either > + Linux or Windows and is unused by any part of DPDK. > + This function is now deprecated and will be removed in DPDK 23.11. > diff --git a/lib/cmdline/cmdline.h b/lib/cmdline/cmdline.h > index b14355ef51..52c89b48bc 100644 > --- a/lib/cmdline/cmdline.h > +++ b/lib/cmdline/cmdline.h > @@ -44,6 +44,8 @@ struct rdline * > cmdline_get_rdline(struct cmdline *cl); > > /** > + * @deprecated Function is broken and scheduled for removal > + * > * This function is nonblocking equivalent of ``cmdline_interact()``. It polls > * *cl* for one character and interpret it. If return value is *RDLINE_EXITED* > * it mean that ``cmdline_quit()`` was invoked. > @@ -55,6 +57,7 @@ cmdline_get_rdline(struct cmdline *cl); > * On success return object status - one of *enum rdline_status*. > * On error return negative value. > */ > +__rte_deprecated > int cmdline_poll(struct cmdline *cl); > > void cmdline_interact(struct cmdline *cl); Reporting the ack I just provided on v1: Acked-by: Maxime Coquelin Thanks, Maxime