[PATCH v3 2/2] doc: announce KNI deprecation

[Jerin Jacob]

On Wed, Nov 24, 2021 at 10:48 PM Ferruh Yigit <ferruh.yigit at intel.com> wrote:
>
> Announce the KNI kernel module move to out of dpdk repo and announce
> long term plan to deprecate the KNI.
>
> Signed-off-by: Ferruh Yigit <ferruh.yigit at intel.com>

Acked-by: Jerin Jacob <jerinj at marvell.com>


> ---
> Cc: Olivier Matz Olivier Matz <olivier.matz at 6wind.com>
> Cc: David Marchand David Marchand <david.marchand at redhat.com>
> Cc: Stephen Hemminger Stephen Hemminger <stephen at networkplumber.org>
> Cc: Elad Nachman <eladv6 at gmail.com>
> Cc: Igor Ryzhov <iryzhov at nfware.com>
> Cc: Dan Gora <dg at adax.com>
>
> Dates are not discussed before, the patch aims to trigger a discussion
> for the dates.
> ---
>  doc/guides/prog_guide/kernel_nic_interface.rst | 2 ++
>  doc/guides/rel_notes/deprecation.rst           | 6 ++++++
>  2 files changed, 8 insertions(+)
>
> diff --git a/doc/guides/prog_guide/kernel_nic_interface.rst b/doc/guides/prog_guide/kernel_nic_interface.rst
> index f5a8b7c0782c..d1c5ccd0851d 100644
> --- a/doc/guides/prog_guide/kernel_nic_interface.rst
> +++ b/doc/guides/prog_guide/kernel_nic_interface.rst
> @@ -7,6 +7,8 @@ Kernel NIC Interface
>  ====================
>
>  .. Note::
> +   KNI kernel module will be moved from main git repository to `dpdk-kmods <https://git.dpdk.org/dpdk-kmods/>`_ repository.
> +   There is a long term plan to deprecate the KNI. See :doc:`../rel_notes/deprecation`
>
>     :ref:`virtio_user_as_exceptional_path` alternative is the preferred way for
>     interfacing with the Linux network stack as it is an in-kernel solution and
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 2262b8de6093..f20852504319 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -48,6 +48,12 @@ 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: KNI kernel module will be moved to `dpdk-kmods <https://git.dpdk.org/dpdk-kmods/>`_
> +  repository by the `DPDK technical board decision
> +  <https://mails.dpdk.org/archives/dev/2021-January/197077.html>`_, on v22.11.
> +* kni: will be depreciated, will remove all kni lib, kernel module and example code
> +  on v23.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.31.1
>