From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <mukawa@igel.co.jp>
Received: from mail-pa0-f43.google.com (mail-pa0-f43.google.com
 [209.85.220.43]) by dpdk.org (Postfix) with ESMTP id ABCBC5A52
 for <dev@dpdk.org>; Thu,  9 Jul 2015 10:10:12 +0200 (CEST)
Received: by pacws9 with SMTP id ws9so148108234pac.0
 for <dev@dpdk.org>; Thu, 09 Jul 2015 01:10:11 -0700 (PDT)
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20130820;
 h=x-gm-message-state:message-id:date:from:user-agent:mime-version:to
 :cc:subject:references:in-reply-to:content-type
 :content-transfer-encoding;
 bh=EmlxzzHeSLDPqzNaBmbdOo2m1BuG5/202/seEe8Don4=;
 b=UT2oa6GSH5O9Q7HdLw8leUB+fasJlw3G6FpS7b7sON16QDSk9ypN5vT03Cn4OELgC/
 EYEi6qDdSSgBKGIxe4UgnIKkYN5NX3w8XHg3w6NaE4X2wMelpVOSx77K0yZKGEoK7OFv
 KPrEBLDBvTJId0bWe5upbH9r6Iy4/aEoiLj/CQ/25+xTp7j3XN7u0BEaf7Kdlqp+HGTU
 GSpTGNxcbzHAL9YHGTMKMBxboZbH8SsxyXzLs9D3jTiOibI3vJbp74PH0zu71bamMJRL
 1h3mxLQEzahL8TrYRA9jX/2Biauio9ga3/4w7OOnEK4HSKT43ZHUQPehYjns+4SZ78hj
 VacA==
X-Gm-Message-State: ALoCoQlUOZ7zn0LNzZMCdqLaCDTRGdzmhO/SjmUV7L6971sFXg4Orrgkpfgx5T9FLWjnC8Av9Zet
X-Received: by 10.68.91.197 with SMTP id cg5mr29175572pbb.26.1436429411877;
 Thu, 09 Jul 2015 01:10:11 -0700 (PDT)
Received: from [10.16.129.101] (napt.igel.co.jp. [219.106.231.132])
 by smtp.googlemail.com with ESMTPSA id pr4sm4965044pbb.30.2015.07.09.01.10.09
 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Thu, 09 Jul 2015 01:10:11 -0700 (PDT)
Message-ID: <559E2C60.4060109@igel.co.jp>
Date: Thu, 09 Jul 2015 17:10:08 +0900
From: Tetsuya Mukawa <mukawa@igel.co.jp>
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64;
 rv:31.0) Gecko/20100101 Thunderbird/31.7.0
MIME-Version: 1.0
To: Thomas Monjalon <thomas.monjalon@6wind.com>
References: <8CEF83825BEC744B83065625E567D7C204A46F17@IRSMSX108.ger.corp.intel.com>
 <1436420764-19513-1-git-send-email-mukawa@igel.co.jp>
 <1854437.Ftu1oaz8Ee@xps13>
In-Reply-To: <1854437.Ftu1oaz8Ee@xps13>
Content-Type: text/plain; charset=windows-1252
Content-Transfer-Encoding: 7bit
Cc: dev@dpdk.org
Subject: Re: [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 <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Thu, 09 Jul 2015 08:10:13 -0000

On 2015/07/09 16:28, Thomas Monjalon wrote:
> 2015-07-09 14:46, Tetsuya Mukawa:
>> 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 <mukawa@igel.co.jp>
>>  /**
>>   * 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().
> Maybe we should tell that stop must be called before close:
> "Close a stopped Ethernet device."

Sure, I will add it and submit again soon.

Tetsuya