From mboxrd@z Thu Jan 1 00:00:00 1970 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) 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=s+m4PKE9QVu4tTg1ujjRcyV9YX1KqEI2cvosp2A9QDQ=; b=asZgbgIu5cunasof+kAJd+dgt+/7kU7pKzkEukLutEjwJfR8v8HBgWV88F+5NZnhtM PSTufRykO+LasxfPcOs6ld9c515MjjtEkY/ugkmApAzCarhIPdrPn7XQ15XA9wH5L8ds uD41sR2OosglNCTqNCDSJQ+EdpEOj1cpdsA1CeXRXDLMWQ0x3fqSgZDEJ0iaUPleUO6t /VDMoZRHN+1Jrue3hoOxRrWE2p0kk5aKoRgkgZ9Lx12SkFi8IG8mzQCHObJXdoxrjvAq w3U4TRy+ufm0/CzZMeZoBv0gG479R8UGUTJfwsrUVPjDgP4SMQQLTOlVy/KM2UK73rsu st0w== X-Gm-Message-State: ALoCoQknEK8/tkb6Q6kQdJbg8GQcKKDr1JyEOLbZmghkJsO4/aDurv9Tp7u9yDaxhg3YAr3EHG9/ X-Received: by 10.66.139.168 with SMTP id qz8mr27647794pab.135.1436420782925; Wed, 08 Jul 2015 22:46:22 -0700 (PDT) Received: from localhost.localdomain (napt.igel.co.jp. [219.106.231.132]) by smtp.gmail.com with ESMTPSA id f1sm4453013pdp.39.2015.07.08.22.46.20 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-SHA bits=128/128); Wed, 08 Jul 2015 22:46:21 -0700 (PDT) From: Tetsuya Mukawa To: dev@dpdk.org Date: Thu, 9 Jul 2015 14:46:04 +0900 Message-Id: <1436420764-19513-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] 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 05:46:24 -0000 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