DPDK patches and discussions
 help / color / mirror / Atom feed
From: Thomas Monjalon <thomas@monjalon.net>
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 <ferruh.yigit@intel.com>
Subject: [PATCH v4] doc: announce KNI deprecation
Date: Wed, 13 Jul 2022 18:10:47 +0200	[thread overview]
Message-ID: <20220713161047.121805-1-thomas@monjalon.net> (raw)
In-Reply-To: <20211124171609.3101896-2-ferruh.yigit@intel.com>

From: Ferruh Yigit <ferruh.yigit@intel.com>

Announce the deprecation plan for KNI kernel module, library and example.

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
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 <https://mails.dpdk.org/archives/dev/2021-January/197077.html>`_
+  and `refinement <http://mails.dpdk.org/archives/dev/2022-June/243596.html>`_.
+  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


  parent reply	other threads:[~2022-07-13 16:10 UTC|newest]

Thread overview: 33+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-23 17:31 [dpdk-dev] [PATCH] doc: note KNI alternatives and deprecation plan Ferruh Yigit
2021-06-23 18:33 ` Stephen Hemminger
2021-06-24  8:19   ` Ferruh Yigit
2021-07-30 12:48 ` Olivier Matz
2021-11-23 10:21   ` Ferruh Yigit
2021-08-20 12:58 ` David Marchand
2021-11-23 10:42   ` Ferruh Yigit
2021-11-23 12:08 ` [PATCH v2 1/2] doc: note KNI alternatives Ferruh Yigit
2021-11-23 12:08   ` [PATCH v2 2/2] doc: announce KNI deprecation Ferruh Yigit
2021-11-24 14:00     ` Thomas Monjalon
2021-11-24 13:58   ` [PATCH v2 1/2] doc: note KNI alternatives Thomas Monjalon
2021-11-24 14:19     ` Ferruh Yigit
2021-11-24 17:16 ` [PATCH v3 " Ferruh Yigit
2021-11-24 17:16   ` [PATCH v3 2/2] doc: announce KNI deprecation Ferruh Yigit
2022-07-11 14:47     ` Jerin Jacob
2022-07-13 10:01     ` Thomas Monjalon
2022-07-13 11:01       ` Bruce Richardson
2022-07-13 16:10     ` Thomas Monjalon [this message]
2022-07-13 19:51       ` [PATCH v4] " Thomas Monjalon
2022-07-15 15:33         ` Thomas Monjalon
2022-07-14  9:20       ` Bruce Richardson
2022-07-14 10:07         ` Thomas Monjalon
2022-07-14 14:50         ` Ferruh Yigit
2022-07-14 15:03           ` Ferruh Yigit
2022-07-15 15:32             ` Thomas Monjalon
2022-07-14  9:30       ` David Marchand
2021-12-01 16:31   ` [PATCH v3 1/2] doc: note KNI alternatives Morten Brørup
2022-11-24 10:31     ` Ferruh Yigit
2022-11-24 11:40   ` [PATCH v5] " Ferruh Yigit
2022-11-24 16:55     ` Stephen Hemminger
2022-11-24 17:08       ` Ferruh Yigit
2022-11-24 17:15     ` [PATCH v6] " Ferruh Yigit
2022-11-26 21:11       ` Thomas Monjalon

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220713161047.121805-1-thomas@monjalon.net \
    --to=thomas@monjalon.net \
    --cc=andrew.rybchenko@oktetlabs.ru \
    --cc=chenbo.xia@intel.com \
    --cc=david.marchand@redhat.com \
    --cc=dev@dpdk.org \
    --cc=ferruh.yigit@intel.com \
    --cc=ferruh.yigit@xilinx.com \
    --cc=jerinj@marvell.com \
    --cc=maxime.coquelin@redhat.com \
    --cc=mdr@ashroe.eu \
    --cc=olivier.matz@6wind.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).