Skip to contentSkip to conversation

doc: add deprecation notice for kni example

PATCH In review Bruce Richardson 6 participants 9 messages Jun 30, 2022 – Jul 13, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 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.

---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +4 -0
index 4e5b23c53d..ee36fc684d 100644
@@ -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.
Signature · 1 line
2.34.1
Acked-by on v1 1/1
#1 lore raw
Quoted 30 lines

-----Original Message-----
From: Bruce Richardson <[email protected]>
Sent: Friday, July 1, 2022 12:51 AM
To: [email protected]
Cc: Richardson, Bruce <[email protected]>
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.

---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +2 -0
index 4e5b23c53d..ee36fc684d 100644
@@ -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 -

doc/guides/rel_notes/deprecation.rst +2 -0
+  other technologies such as virtio-user are recommended instead.
+  Because of this, the example application for kni is deprecated and will
Quoted 3 lines

be removed in a future release.
--
2.34.1

Acked-by on v1 1/1
#4 lore raw
In reply to Bruce Richardson

30/06/2022 18:50, Bruce Richardson:

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 131

Quoted 3 lines
doc/guides/rel_notes/deprecation.rst +3 -0
+* 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.

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

#5 lore raw
Quoted 8 lines · Thomas Monjalon

30/06/2022 18:50, Bruce Richardson:

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 131

Quoted 3 lines
doc/guides/rel_notes/deprecation.rst +3 -0
+* 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.

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

+1

#6 lore raw
In reply to Thomas Monjalon
Quoted 9 lines · Thomas Monjalon

30/06/2022 18:50, Bruce Richardson:

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 131

Quoted 3 lines
doc/guides/rel_notes/deprecation.rst +3 -0
+* 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.

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

#7 lore raw

13/07/2022 10:14, Bruce Richardson:

Quoted 6 lines · Thomas Monjalon
Quoted 5 lines

30/06/2022 18:50, Bruce Richardson:

Quoted 3 lines
doc/guides/rel_notes/deprecation.rst +3 -0
+* 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.
Quoted 7 lines
Quoted 4 lines

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.

#8 lore raw

13/07/2022 11:11, Thomas Monjalon:

Quoted 9 lines

13/07/2022 10:14, Bruce Richardson:

Quoted 8 lines · Thomas Monjalon
Quoted 7 lines

30/06/2022 18:50, Bruce Richardson:

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 131

Quoted 3 lines
doc/guides/rel_notes/deprecation.rst +3 -0
+* 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.
Quoted 7 lines
Quoted 5 lines
Quoted 2 lines

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/[email protected]/

Please review quickly.