[PATCH] doc: add deprecation notice for kni example

[PATCH] doc: add deprecation notice for kni example

[Bruce Richardson]

As agreed by DPDK Technical Board, the KNI example app is due to be
removed from the repository to discourage use in future projects, given
that better alternatives exist.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..ee36fc684d 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -125,3 +125,7 @@ Deprecation Notices
   applications should be updated to use the ``dmadev`` library instead,
   with the underlying HW-functionality being provided by the ``ioat`` or
   ``idxd`` dma drivers
+
+* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications -
+  other technologies such as virtio-user are recommended instead.
+  Because of this, the example application for kni is deprecated and will be removed in a future release.
-- 
2.34.1

RE: [PATCH] doc: add deprecation notice for kni example

[Xia, Chenbo]

> -----Original Message-----
> From: Bruce Richardson <bruce.richardson@intel.com>
> Sent: Friday, July 1, 2022 12:51 AM
> To: dev@dpdk.org
> Cc: Richardson, Bruce <bruce.richardson@intel.com>
> Subject: [PATCH] doc: add deprecation notice for kni example
> 
> As agreed by DPDK Technical Board, the KNI example app is due to be
> removed from the repository to discourage use in future projects, given
> that better alternatives exist.
> 
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 4e5b23c53d..ee36fc684d 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -125,3 +125,7 @@ Deprecation Notices
>    applications should be updated to use the ``dmadev`` library instead,
>    with the underlying HW-functionality being provided by the ``ioat`` or
>    ``idxd`` dma drivers
> +
> +* examples/kni: The ``kni`` kernel module and library are not recommended
> for use by new applications -
> +  other technologies such as virtio-user are recommended instead.
> +  Because of this, the example application for kni is deprecated and will
> be removed in a future release.
> --
> 2.34.1

Acked-by: Chenbo Xia <chenbo.xia@intel.com>

Re: [PATCH] doc: add deprecation notice for kni example

[David Marchand]

On Thu, Jun 30, 2022 at 6:50 PM Bruce Richardson
<bruce.richardson@intel.com> wrote:
>
> As agreed by DPDK Technical Board, the KNI example app is due to be
> removed from the repository to discourage use in future projects, given
> that better alternatives exist.
>
> Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: David Marchand <david.marchand@redhat.com>


-- 
David Marchand

Re: [PATCH] doc: add deprecation notice for kni example

[Jerin Jacob]

On Fri, Jul 1, 2022 at 1:48 PM David Marchand <david.marchand@redhat.com> wrote:
>
> On Thu, Jun 30, 2022 at 6:50 PM Bruce Richardson
> <bruce.richardson@intel.com> wrote:
> >
> > As agreed by DPDK Technical Board, the KNI example app is due to be
> > removed from the repository to discourage use in future projects, given
> > that better alternatives exist.
> >
> > Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
>
> Acked-by: David Marchand <david.marchand@redhat.com>

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

>
>
> --
> David Marchand
>

Re: [PATCH] doc: add deprecation notice for kni example

[Thomas Monjalon]

30/06/2022 18:50, Bruce Richardson:
> +* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications -
> +  other technologies such as virtio-user are recommended instead.
> +  Because of this, the example application for kni is deprecated and will be removed in a future release.

Acked-by: Thomas Monjalon <thomas@monjalon.net>

I think it would have been better to give a precise timeline.

Re: [PATCH] doc: add deprecation notice for kni example

[Andrew Rybchenko]

On 7/12/22 17:17, Thomas Monjalon wrote:
> 30/06/2022 18:50, Bruce Richardson:
>> +* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications -
>> +  other technologies such as virtio-user are recommended instead.
>> +  Because of this, the example application for kni is deprecated and will be removed in a future release.
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
> 
> I think it would have been better to give a precise timeline.

+1

Acked-by: Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>

Re: [PATCH] doc: add deprecation notice for kni example

[Bruce Richardson]

On Tue, Jul 12, 2022 at 04:17:31PM +0200, Thomas Monjalon wrote:
> 30/06/2022 18:50, Bruce Richardson:
> > +* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications -
> > +  other technologies such as virtio-user are recommended instead.
> > +  Because of this, the example application for kni is deprecated and will be removed in a future release.
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
> 
> I think it would have been better to give a precise timeline.
> 
I intentionally left it vague in case we decided to defer removal for a
release or anything. However, feel free to replace "in a future" release
with "in 22.11 release" on apply if you like.

/Bruce

Re: [PATCH] doc: add deprecation notice for kni example

[Thomas Monjalon]

13/07/2022 10:14, Bruce Richardson:
> On Tue, Jul 12, 2022 at 04:17:31PM +0200, Thomas Monjalon wrote:
> > 30/06/2022 18:50, Bruce Richardson:
> > > +* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications -
> > > +  other technologies such as virtio-user are recommended instead.
> > > +  Because of this, the example application for kni is deprecated and will be removed in a future release.
> > 
> > Acked-by: Thomas Monjalon <thomas@monjalon.net>
> > 
> > I think it would have been better to give a precise timeline.
> > 
> I intentionally left it vague in case we decided to defer removal for a
> release or anything. However, feel free to replace "in a future" release
> with "in 22.11 release" on apply if you like.

I won't do such change myself, too much critical.

Re: [PATCH] doc: add deprecation notice for kni example

[Thomas Monjalon]

13/07/2022 11:11, Thomas Monjalon:
> 13/07/2022 10:14, Bruce Richardson:
> > On Tue, Jul 12, 2022 at 04:17:31PM +0200, Thomas Monjalon wrote:
> > > 30/06/2022 18:50, Bruce Richardson:
> > > > +* examples/kni: The ``kni`` kernel module and library are not recommended for use by new applications -
> > > > +  other technologies such as virtio-user are recommended instead.
> > > > +  Because of this, the example application for kni is deprecated and will be removed in a future release.
> > > 
> > > Acked-by: Thomas Monjalon <thomas@monjalon.net>
> > > 
> > > I think it would have been better to give a precise timeline.
> > > 
> > I intentionally left it vague in case we decided to defer removal for a
> > release or anything. However, feel free to replace "in a future" release
> > with "in 22.11 release" on apply if you like.
> 
> I won't do such change myself, too much critical.

I've sent a new deprecation which updates Ferruh's one,
and squash parts of this one about the example:
https://patches.dpdk.org/project/dpdk/patch/20220713161047.121805-1-thomas@monjalon.net/

Please review quickly.