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 99B37A00C5; Wed, 13 Jul 2022 18:10:54 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 380384282D; Wed, 13 Jul 2022 18:10:54 +0200 (CEST) Received: from out3-smtp.messagingengine.com (out3-smtp.messagingengine.com [66.111.4.27]) by mails.dpdk.org (Postfix) with ESMTP id 82BDB4280D for ; Wed, 13 Jul 2022 18:10:53 +0200 (CEST) Received: from compute5.internal (compute5.nyi.internal [10.202.2.45]) by mailout.nyi.internal (Postfix) with ESMTP id C8A415C006C; Wed, 13 Jul 2022 12:10:52 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute5.internal (MEProxy); Wed, 13 Jul 2022 12:10:52 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:cc:content-transfer-encoding:date:date:from:from:in-reply-to :in-reply-to:message-id:mime-version:references:reply-to:sender :subject:subject:to:to; s=fm3; t=1657728652; x=1657815052; bh=d8 WOPijtFWzyiEs2VcMmxou0X8XCeeMzu3ONGlTBEDA=; b=S2jt4N2BHOAuWC1FBj y9OixIeKaKe5MVvtp2+XHXDvaNxu1saouMPBu+B/mldEAw3Dht1+k05NcordJKkt DnZO2koUaq5p9P/Fnq7cKCao+v8cOwgWJEkLAMMdIYOUxqzr05rkpaI72r7xYZdw b2Zdl1/2t2sv4IqPcDwIMxU54X9vCMAhRkBVZRUs8aPVFWFeYZuqhiWStaefC8eh 64uKP8oC/urbbTuDS1eh3+4qcHvU8pZ1WnaMFtNDgYJlaALGEmCla4MHmX3AQQQ7 eaXJiHC6WcXGOVqqzL2RTW5BsaROqWxQZBxFdm99pIEf7wjMxH5ZXLuTNcmmAu+z Hdyg== DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:cc:content-transfer-encoding:date:date :feedback-id:feedback-id:from:from:in-reply-to:in-reply-to :message-id:mime-version:references:reply-to:sender:subject :subject:to:to:x-me-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; t=1657728652; x=1657815052; bh=d8WOPijtFWzyi Es2VcMmxou0X8XCeeMzu3ONGlTBEDA=; b=mOj0FVDbq3FO81MviIhkskOWL9uPC M/Rb+GRsQK7UOtlkSVPhDKEp4o5p4e7TQt4LWO7XX22WHYC7sL5tuJ7q4WGaGs0u imuiSYfHZ5jCgDcI5n6+eLBtoZlZUBZMIVQIn8hoeuuVejsXCaqacLf7diutiBtH 8Z0ddDUk81+bwQGl3aFvq3FVWlVEYVCFBSmxXiSNvlLm0Z9BNsDVZJ/lwOhYO3tK /2zv+soW8kZFTCTTfZjNNxWa54ekGrbsZqAmk2vyzG4I+5rzZ5+G0Obd/pftlAmu ty/FBXoznWZbhF5ZHepbdEajmSX4MxH19OOQWXbz+sOn3FFH7w10uP4Ew== X-ME-Sender: X-ME-Received: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgedvfedrudejjedgleejucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvvefufffkofgjfhgggfestdekredtredttdenucfhrhhomhepvfhhohhm rghsucfoohhnjhgrlhhonhcuoehthhhomhgrshesmhhonhhjrghlohhnrdhnvghtqeenuc ggtffrrghtthgvrhhnpedtheejieffhfejkeejkedvhedvfeeitefgkeeitdeileeukeev teekieeujeehffenucffohhmrghinhepughpughkrdhorhhgnecuvehluhhsthgvrhfuih iivgeptdenucfrrghrrghmpehmrghilhhfrhhomhepthhhohhmrghssehmohhnjhgrlhho nhdrnhgvth X-ME-Proxy: Feedback-ID: i47234305:Fastmail Received: by mail.messagingengine.com (Postfix) with ESMTPA; Wed, 13 Jul 2022 12:10:50 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: david.marchand@redhat.com, andrew.rybchenko@oktetlabs.ru, maxime.coquelin@redhat.com, chenbo.xia@intel.com, mdr@ashroe.eu, ferruh.yigit@xilinx.com, olivier.matz@6wind.com, jerinj@marvell.com, Ferruh Yigit Subject: [PATCH v4] doc: announce KNI deprecation Date: Wed, 13 Jul 2022 18:10:47 +0200 Message-Id: <20220713161047.121805-1-thomas@monjalon.net> X-Mailer: git-send-email 2.36.1 In-Reply-To: <20211124171609.3101896-2-ferruh.yigit@intel.com> References: <20211124171609.3101896-2-ferruh.yigit@intel.com> 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: Ferruh Yigit Announce the deprecation plan for KNI kernel module, library and example. Signed-off-by: Ferruh Yigit Signed-off-by: Thomas Monjalon --- Squashed and updated 2 deprecations: https://patches.dpdk.org/project/dpdk/patch/20211124171609.3101896-2-ferruh.yigit@intel.com/ https://patches.dpdk.org/project/dpdk/patch/20211124171609.3101896-2-ferruh.yigit@intel.com/ --- doc/guides/prog_guide/kernel_nic_interface.rst | 3 +++ doc/guides/rel_notes/deprecation.rst | 9 +++++++++ 2 files changed, 12 insertions(+) diff --git a/doc/guides/prog_guide/kernel_nic_interface.rst b/doc/guides/prog_guide/kernel_nic_interface.rst index e021cc69b6..03b5bca958 100644 --- a/doc/guides/prog_guide/kernel_nic_interface.rst +++ b/doc/guides/prog_guide/kernel_nic_interface.rst @@ -8,6 +8,9 @@ Kernel NIC Interface .. note:: + KNI is deprecated and will be removed in future. + See :doc:`../rel_notes/deprecation`. + For an alternative to KNI, that does not require any out-of-tree Linux kernel modules, or a custom library, see :ref:`virtio_user_as_exception_path`. diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4e5b23c53d..e54597c591 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -48,6 +48,15 @@ Deprecation Notices in the header will not be considered as ABI anymore. This change is inspired by the RFC https://patchwork.dpdk.org/project/dpdk/list/?series=17176. +* kni: The KNI kernel module and library are not recommended for use by new + applications - other technologies such as virtio-user are recommended instead. + The KNI kernel module and library will be removed from DPDK 23.11, + following the DPDK technical board + `decision `_ + and `refinement `_. + The first steps are to add deprecation warnings + and to remove the example application from 22.11. + * lib: will fix extending some enum/define breaking the ABI. There are multiple samples in DPDK that enum/define terminated with a ``.*MAX.*`` value which is used by iterators, and arrays holding these values are sized with this -- 2.36.1