d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: announce KNI deprecation

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

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
This commit is contained in:
Ferruh Yigit 2021-11-24 17:16:09 +00:00 committed by Thomas Monjalon
parent 3dee77b662
commit 4608927edf
2 changed files with 13 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/guides/prog_guide/kernel_nic_interface.rst
View File

@ -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`.

10
doc/guides/rel_notes/deprecation.rst
View File

@ -48,6 +48,16 @@ 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.
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>`_:
* Some deprecation warnings will be added in DPDK 22.11.
* The KNI example application will be removed from DPDK 22.11.
* The KNI kernel module, library and PMD will be removed from the DPDK 23.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