From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tetsuya Mukawa Subject: [PATCH] doc: Fix doxygen comments of rte_eth_dev_close() and rte_eth_dev_detach() Date: Thu, 9 Jul 2015 14:46:04 +0900 Message-ID: <1436420764-19513-1-git-send-email-mukawa@igel.co.jp> References: <8CEF83825BEC744B83065625E567D7C204A46F17@IRSMSX108.ger.corp.intel.com> To: dev@dpdk.org Return-path: Received: from mail-pd0-f171.google.com (mail-pd0-f171.google.com [209.85.192.171]) by dpdk.org (Postfix) with ESMTP id A1C325A66 for ; Thu, 9 Jul 2015 07:46:23 +0200 (CEST) Received: by pdrg1 with SMTP id g1so27176455pdr.2 for ; Wed, 08 Jul 2015 22:46:23 -0700 (PDT) In-Reply-To: <8CEF83825BEC744B83065625E567D7C204A46F17@IRSMSX108.ger.corp.intel.com> List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" The patch fixes doxygen comments of below functions. - rte_eth_dev_close() Add description 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 --- lib/librte_ether/rte_ethdev.h | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/lib/librte_ether/rte_ethdev.h b/lib/librte_ether/rte_ethdev.h index 438d59a..3148416 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. @@ -1987,6 +1989,8 @@ extern int rte_eth_dev_set_link_down(uint8_t port_id); /** * Close an 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