ring: fix return of new port id on creation
authorBruce Richardson <bruce.richardson@intel.com>
Thu, 18 Jun 2015 13:28:41 +0000 (14:28 +0100)
committerThomas Monjalon <thomas.monjalon@6wind.com>
Mon, 22 Jun 2015 15:33:23 +0000 (17:33 +0200)
commit9c6dfcb720806dbded289d9aecb26f02f001dd49
treec6ac3e83ff4161c308bb8ebff8b497a8315192d7
parent5e73a1269ba0a501138ff82c945faff4106d9d7e
ring: fix return of new port id on creation

The rte_eth_from_rings API allowed the creation of an ethdev port at
runtime using rte_rings as the underlying storage. However, the return
value from this function was either 0 or -1, and these values were never
actually documented in the API documentation. Unfortunately, the programmers
guide doc examples for this API implied that the return value from this
function was the port id of the newly created ethdev.

Since this latter behaviour is more useful - and already implied by the
documentation, this patch changes the return 0 to "return
data->port_id". It also adds in doxygen comments for the function so it
can be correctly documented in the API reference.

Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
drivers/net/ring/rte_eth_ring.c
drivers/net/ring/rte_eth_ring.h