doc: announce API change to remove exit calls in libs
authorThomas Monjalon <thomas@monjalon.net>
Wed, 8 May 2019 20:54:13 +0000 (22:54 +0200)
committerThomas Monjalon <thomas@monjalon.net>
Mon, 13 May 2019 20:52:34 +0000 (22:52 +0200)
Two public functions from EAL and metrics libraries need to return
some new error codes instead of calling rte_panic or rte_exit.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Arnon Warshavsky <arnon@qwilt.com>
Acked-by: David Marchand <david.marchand@redhat.com>
Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
doc/guides/rel_notes/deprecation.rst

index b47c8c2..e612784 100644 (file)
@@ -20,6 +20,9 @@ Deprecation Notices
 * kvargs: The function ``rte_kvargs_process`` will get a new parameter
   for returning key match count. It will ease handling of no-match case.
 
+* eal: The function ``rte_eal_remote_launch`` will return new error codes
+  after read or write error on the pipe, instead of calling ``rte_panic``.
+
 * eal: both declaring and identifying devices will be streamlined in v18.11.
   New functions will appear to query a specific port from buses, classes of
   device and device drivers. Device declaration will be made coherent with the
@@ -82,3 +85,6 @@ Deprecation Notices
 * cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
   structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
   ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
+
+* metrics: The function ``rte_metrics_init`` will have a non-void return
+  in order to notify errors instead of calling ``rte_exit``.