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 970D842F6A; Fri, 28 Jul 2023 12:15:59 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 198E140685; Fri, 28 Jul 2023 12:15:59 +0200 (CEST) Received: from mgamail.intel.com (unknown [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id 3615C4021E for ; Fri, 28 Jul 2023 12:15:57 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1690539357; x=1722075357; h=from:to:cc:subject:date:message-id:in-reply-to: references:mime-version:content-transfer-encoding; bh=5GRf0MeEILm+VdreAHqHvvaH4Kr46iLXa63AunLKAC0=; b=HgybuiGAKI6LV+XEi0CRcUKNHz6iYkuDOZ3SbiruJbVcA4sOtvcM9MjO MJUD+hhnTLNOrRBOAuYXOZ/m/ck8o802hMCHL0RBgv7+lnMM66RwjE3j7 JPrkRRYMIuIvyrI36QNzmR5Flj250zhG6OuXauA5H3kCRu6kDLjOsd4E1 cuOEUl26Z3j91SlV78ehGX6EKEfLuZpjbBMxt8eNK1AA5u69yndqsotZk vLY0iXI5yOR+x022eo+9r1WGT99jcK2llfLQq0wUgB3Ese5qw0Kg2RIqs qutBpIlahgVnk8n4Tg3SraH5B++QpvuQd3HFp1wf3e0Uvgwon5AqVOllK Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10784"; a="432374143" X-IronPort-AV: E=Sophos;i="6.01,237,1684825200"; d="scan'208";a="432374143" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 28 Jul 2023 03:15:55 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10784"; a="677489946" X-IronPort-AV: E=Sophos;i="6.01,237,1684825200"; d="scan'208";a="677489946" Received: from silpixa00401385.ir.intel.com ([10.237.214.14]) by orsmga003.jf.intel.com with ESMTP; 28 Jul 2023 03:15:54 -0700 From: Bruce Richardson To: dev@dpdk.org Cc: Stephen Hemminger , Bruce Richardson , Olivier Matz Subject: [PATCH v2] doc: announce deprecation of cmdline_poll Date: Fri, 28 Jul 2023 11:15:42 +0100 Message-Id: <20230728101542.59909-1-bruce.richardson@intel.com> X-Mailer: git-send-email 2.39.2 In-Reply-To: <20230314171858.67446-1-stephen@networkplumber.org> References: <20230314171858.67446-1-stephen@networkplumber.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit 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 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); -- 2.39.2