diff mbox series

doc: announce API change to remove exit calls in libs

Message ID 20190508205413.31134-1-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce API change to remove exit calls in libs |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon May 8, 2019, 8:54 p.m. UTC 
  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>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Arnon Warshavsky May 9, 2019, 5:31 a.m. UTC | #1 
On Wed, May 8, 2019 at 11:54 PM Thomas Monjalon <thomas@monjalon.net> wrote:

> 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>
> ---
>
> --
> 2.21.0
>
>
Acked-By: Arnon Warshavsky <arnon@qwilt.com>
David Marchand May 9, 2019, 7:34 a.m. UTC | #2 
On Wed, May 8, 2019 at 10:54 PM Thomas Monjalon <thomas@monjalon.net> wrote:

> 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>
> ---
>  doc/guides/rel_notes/deprecation.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index b47c8c254..e61278429 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -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``.
> +
>

Nit: do we need error codes ? or only a single new error code ?


 * 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``.
> --
> 2.21.0
>
>
Acked-by: David Marchand <david.marchand@redhat.com>
Thomas Monjalon May 9, 2019, 7:38 a.m. UTC | #3 
09/05/2019 09:34, David Marchand:
> On Wed, May 8, 2019 at 10:54 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > +* 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``.
> > +
> >
> 
> Nit: do we need error codes ? or only a single new error code ?

That's something to discuss.
In my opinion, we should return any errno from read and write syscalls:
	return -errno;
Ferruh Yigit May 9, 2019, 2:55 p.m. UTC | #4 
On 5/8/2019 9:54 PM, Thomas Monjalon wrote:
> 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: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon May 13, 2019, 8:54 p.m. UTC | #5 
09/05/2019 07:31, Arnon Warshavsky:
> On Wed, May 8, 2019 at 11:54 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> 
> > 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>

Applied
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index b47c8c254..e61278429 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -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``.