The patch fixes doxygen comments of below functions. - rte_eth_dev_close() Add description about when the function can be called and also about what kind of resources will be freed. - rte_eth_dev_detach() Add description about when the function can be called.
Signed-off-by: Tetsuya Mukawa <mukawa at igel.co.jp> --- lib/librte_ether/rte_ethdev.h | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 438d59a..f4e3d42 100644 --- a/lib/librte_ether/rte_ethdev.h +++ b/lib/librte_ether/rte_ethdev.h @@ -1633,6 +1633,8 @@ int rte_eth_dev_attach(const char *devargs, uint8_t *port_id); /** * Detach a Ethernet device specified by port identifier. + * This function must be called when the device is in the + * closed state. * * @param port_id * The port identifier of the device to detach. @@ -1986,7 +1988,9 @@ extern int rte_eth_dev_set_link_up(uint8_t port_id); extern int rte_eth_dev_set_link_down(uint8_t port_id); /** - * Close an Ethernet device. The device cannot be restarted! + * Close a stopped Ethernet device. The device cannot be restarted! + * The function frees all resources except for needed by the + * closed state. To free these resources, call rte_eth_dev_detach(). * * @param port_id * The port identifier of the Ethernet device. -- 2.1.4
