doc: announce ethdev functions will not return void
authorAndrew Rybchenko <arybchenko@solarflare.com>
Tue, 23 Jul 2019 14:07:51 +0000 (15:07 +0100)
committerThomas Monjalon <thomas@monjalon.net>
Sat, 10 Aug 2019 20:33:38 +0000 (22:33 +0200)
commitfbe7ac9f3a9916ad09d4c4c028efbeb6e1c23d2a
treee059914b1700e557dc3b6ce97515277c131cc9b3
parent9c8a4aba02a2860cced933c38b7d0ec956a88715
doc: announce ethdev functions will not return 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: Ferruh Yigit <ferruh.yigit@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
Acked-by: Jerin Jacob <jerinj@marvell.com>
doc/guides/rel_notes/deprecation.rst