[dpdk-dev] [PATCH] doc: announce ABI change on eal and kni

[Arnon Warshavsky <arnon@qwilt.com>]

For the purpose of removing instances of rte_panic
from the init sequence, some void functions need to change
to return an error code.The planned modifications of 19.08
require to change one eal function and one kni function.

Signed-off-by: Arnon Warshavsky <arnon@qwilt.com>
---
 doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index b47c8c2..c4ab9a2 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -31,6 +31,12 @@ Deprecation Notices
 
     + ``rte_eal_devargs_type_count``
 
+* eal: Modify function return value for the sake of removing rte_panic
+       from the init sequence in version 19.08.
+  - In ``lib/librte_eal/common/eal_thread.h`` replace
+    ``void eal_thread_init_master(unsigned lcore_id)``
+    to return ``int``
+
 * vfio: removal of ``rte_vfio_dma_map`` and ``rte_vfio_dma_unmap`` APIs which
   have been replaced with ``rte_dev_dma_map`` and ``rte_dev_dma_unmap``
   functions.  The due date for the removal targets DPDK 20.02.
@@ -65,6 +71,12 @@ Deprecation Notices
   kernel modules in DPDK. As a result users won't be able to use ``ethtool``
   via ``igb`` & ``ixgbe`` anymore.
 
+* kni: Modify function return value for the sake of removing rte_panic
+       from the init sequence in version 19.08.
+  - In ``lib/librte_kni/rte_kni_fifo.h`` replace
+    ``static void kni_fifo_init(struct rte_kni_fifo *fifo, unsigned size)``
+    to return ``int``
+
 * cryptodev: New member in ``rte_cryptodev_config`` to allow applications to
   disable features supported by the crypto device. Only the following features
   would be allowed to be disabled this way,
-- 
1.8.3.1