From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mail-pa0-f53.google.com (mail-pa0-f53.google.com [209.85.220.53]) by dpdk.org (Postfix) with ESMTP id 212C25A7A for ; Thu, 9 Jul 2015 10:21:52 +0200 (CEST) Received: by pabvl15 with SMTP id vl15so146623488pab.1 for ; Thu, 09 Jul 2015 01:21:51 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20130820; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references; bh=NqhGVi3poS+Wmp/UasvAY6k5yt4zAalAAxES5TwiqIE=; b=IS4icTtqv19u85D7znISZ9sW3OvD8bC9+DAtcWdF3XgclROE/52DHNvA0om0/W+5FR Br6FBl0RqoKzOiJydKWRhLRtONdZkeJU0lyWObUEbQUTKzs9DdE/ggD2+8vXcCzdOYWR /hQ+UWYTsF6p9by+39Nn9K8Jh+0/iHaAvxHlbODRl0Q4ZYDsdRNdgo4m/FUClKtnVTXQ iMo6iNh8GHsHl5xuVicEFgLXG5flIEAdvPFOAEn+bieb4fQ2eTk6cFCfdLjui8gfsU6Y R3xeL7x022JWvi1p/E5fqTH9mwuhRiseVe9JDSrciyVpSJAnKvhU4AZ/V1EL50n698xX B01g== X-Gm-Message-State: ALoCoQmajL3Q26O7QJ+sEc9IP/8p4fw8xT27vsr3fbm45mHMLLE7j63Oij0pi/eAoqf/a4HdcInY X-Received: by 10.68.93.229 with SMTP id cx5mr29192167pbb.104.1436430111530; Thu, 09 Jul 2015 01:21:51 -0700 (PDT) Received: from localhost.localdomain (napt.igel.co.jp. [219.106.231.132]) by smtp.gmail.com with ESMTPSA id kw5sm5016154pab.29.2015.07.09.01.21.49 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Thu, 09 Jul 2015 01:21:50 -0700 (PDT) From: Tetsuya Mukawa To: dev@dpdk.org Date: Thu, 9 Jul 2015 17:19:14 +0900 Message-Id: <1436429954-19924-1-git-send-email-mukawa@igel.co.jp> X-Mailer: git-send-email 2.1.4 In-Reply-To: <8CEF83825BEC744B83065625E567D7C204A46F17@IRSMSX108.ger.corp.intel.com> References: <8CEF83825BEC744B83065625E567D7C204A46F17@IRSMSX108.ger.corp.intel.com> Subject: [dpdk-dev] [PATCH v2] doc: Fix doxygen comments of rte_eth_dev_close() and rte_eth_dev_detach() X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 09 Jul 2015 08:21:52 -0000 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 --- 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