From: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
To: Andrew Rybchenko <arybchenko@solarflare.com>,
Thomas Monjalon <thomas@monjalon.net>,
Ferruh Yigit <ferruh.yigit@intel.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH] doc: add deprecation notice to fix ethdev API returning void
Date: Wed, 24 Jul 2019 09:17:15 +0000 [thread overview]
Message-ID: <BYAPR18MB2424DA113BA456E97D952A8CC8C60@BYAPR18MB2424.namprd18.prod.outlook.com> (raw)
In-Reply-To: <1563890871-26901-1-git-send-email-arybchenko@solarflare.com>
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Andrew Rybchenko
> Sent: Tuesday, July 23, 2019 7:38 PM
> To: Thomas Monjalon <thomas@monjalon.net>; Ferruh Yigit
> <ferruh.yigit@intel.com>
> Cc: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: add deprecation notice to fix ethdev API
> returning void
>
> void return value is bad for get API (like rte_eth_dev_info-get()) since caller
> does not know if the function does its job or not and output value is filled in.
>
> void return value is bad for state changing API (like
> rte_eth_promiscuous_enable()) since caller should use get API to
> understand if state is really changed.
>
> Signed-off-by: Andrew Rybchenko <arybchenko@solarflare.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
> ---
> doc/guides/rel_notes/deprecation.rst | 14 ++++++++++++++
> 1 file changed, 14 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 37b8592b6..79689f136 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -59,6 +59,20 @@ Deprecation Notices
> Target release for removal of the legacy API will be defined once most
> PMDs have switched to rte_flow.
>
> +* ethdev: update API functions returning ``void`` to return ``int``
> +with
> + negative errno values to indicate various error conditions (e.g.
> + invalid port ID, unsupported operation, failed operation):
> +
> + - ``rte_eth_dev_info_get``
> + - ``rte_eth_promiscuous_enable`` and ``rte_eth_promiscuous_disable``
> + - ``rte_eth_allmulticast_enable`` and
> + ``rte_eth_allmulticast_disable``
> + - ``rte_eth_link_get`` and ``rte_eth_link_get_nowait``
> + - ``rte_eth_dev_stop``
> + - ``rte_eth_dev_close``
> + - ``rte_eth_xstats_reset``
> + - ``rte_eth_macaddr_get``
> + - ``rte_eth_dev_owner_delete``
> +
> * cryptodev: support for using IV with all sizes is added, J0 still can
> be used but only when IV length in following structs
> ``rte_crypto_auth_xform``,
> ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
> --
> 2.17.1
prev parent reply other threads:[~2019-07-24 9:17 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-07-23 14:07 Andrew Rybchenko
2019-07-23 14:22 ` Ferruh Yigit
2019-08-06 11:24 ` Thomas Monjalon
2019-08-10 20:29 ` Thomas Monjalon
2019-07-23 14:38 ` Stephen Hemminger
2019-07-23 14:52 ` Andrew Rybchenko
2019-07-24 9:17 ` Jerin Jacob Kollanukkaran [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=BYAPR18MB2424DA113BA456E97D952A8CC8C60@BYAPR18MB2424.namprd18.prod.outlook.com \
--to=jerinj@marvell.com \
--cc=arybchenko@solarflare.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).