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 4ED99A00C5; Thu, 14 Jul 2022 11:20:48 +0200 (CEST) Received: from [217.70.189.124] (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id E442042B6D; Thu, 14 Jul 2022 11:20:47 +0200 (CEST) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by mails.dpdk.org (Postfix) with ESMTP id A59AD4282B for ; Thu, 14 Jul 2022 11:20:45 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1657790445; x=1689326445; h=date:from:to:cc:subject:message-id:references: mime-version:in-reply-to; bh=VYD3DUNaIiQit8XdBB+YMrmJc1HshnD0z4GwzKgP/QU=; b=eKqxJwzKWvGGlTJlVhr86TizsZJjz6sVX/yt05Fc5Duyj+o5s/aiU9vM 8SMqmSSdUKKcRIrnHr4cFMARWXzAUQA/cnrv6T+KnL3KS1uiz827JulG2 GQEKA4zDEaVwHsim0v4JJ/zFAHAFjdu2uVlo5PSrfEUWrjmxagwEqrpkL E6Th7Ngrr2IAIr/TAjAoZIJVlcoctl3BP8rRCjae34EbDXY1QSjLESHSI 7TwCdkLNT2o7o4si3KugyY8oV+A+ml/KHmhqhUYTRkT3awdeO8GOkXhGz WKG0aPbl7bTps9mQ4lttx/sBTytC7sVtRlErORRLTZmg1qRZHLB5JM3p4 A==; X-IronPort-AV: E=McAfee;i="6400,9594,10407"; a="283017429" X-IronPort-AV: E=Sophos;i="5.92,269,1650956400"; d="scan'208";a="283017429" Received: from orsmga003.jf.intel.com ([10.7.209.27]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 14 Jul 2022 02:20:44 -0700 X-IronPort-AV: E=Sophos;i="5.92,269,1650956400"; d="scan'208";a="546201543" Received: from bricha3-mobl.ger.corp.intel.com ([10.252.19.126]) by orsmga003-auth.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-SHA; 14 Jul 2022 02:20:42 -0700 Date: Thu, 14 Jul 2022 10:20:38 +0100 From: Bruce Richardson To: Thomas Monjalon Cc: dev@dpdk.org, 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: Re: [PATCH v4] doc: announce KNI deprecation Message-ID: References: <20211124171609.3101896-2-ferruh.yigit@intel.com> <20220713161047.121805-1-thomas@monjalon.net> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20220713161047.121805-1-thomas@monjalon.net> 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 Wed, Jul 13, 2022 at 06:10:47PM +0200, Thomas Monjalon wrote: > 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/ > --- One suggestion below. With corrected link and with/without suggested change: Acked-by: Bruce Richardson > 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. > + I wonder whether having this done as bullet points in chronological order might be clearer. Something like: * kni: The KNI kernel module and library are not recommended for use by new applications - other technologies such as virtio-user are recommended instead. Following the DPDK technical board `decision `_ and `refinement `_: * The KNI example application will be removed from DPDK 22.11 release * The KNI kernel module and library will be removed from the DPDK 23.11 release