From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <thomas.monjalon@6wind.com>
Received: from mail-wi0-f181.google.com (mail-wi0-f181.google.com
 [209.85.212.181]) by dpdk.org (Postfix) with ESMTP id 3C3B4952
 for <dev@dpdk.org>; Thu,  9 Jul 2015 09:29:14 +0200 (CEST)
Received: by wifm2 with SMTP id m2so9773845wif.1
 for <dev@dpdk.org>; Thu, 09 Jul 2015 00:29:13 -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:organization
 :user-agent:in-reply-to:references:mime-version
 :content-transfer-encoding:content-type;
 bh=BCodQw8OWhs0SdJ7/rnb4dbcgobR5zyUewlW6TDAN40=;
 b=gWnM4VKoErIl6oydlUKQ0+wBP6E4OYLniV5kn2xhdRm+CkAF0Ro3FooqnU0+F9I2Uw
 7GKoqTGC9uaW8iZAH4N0yGMYZYLKKI8zTDb9UTaqlGmuir3JVrqQhsIvCa30YoSUnIzQ
 K5WAEacgQPvGVlcEEftcXqkfUxDj5xbdXPwTlQ350G1hPBBJIQ91y19YZy2DnFAw6hWK
 4AFE+HfGCitSDHKByTxfyM+R7/b2c9MYp6Hh1wtHn0fo4gH9sfhAWF11LNP6woLlt/vd
 tOQD2PmXysvyjV1r5AV77APDSu1ct3r3gWTYib8iFXq5X0rVFvVfseMgp55vw4CfTZPe
 ZssA==
X-Gm-Message-State: ALoCoQkK8MbZZLViLGlzCML56b0o8QVOQeFdUn3n/gXtOJez2gMBOI5+ivMHVnL4vgNn8cGCBqrW
X-Received: by 10.194.243.230 with SMTP id xb6mr27801423wjc.13.1436426953067; 
 Thu, 09 Jul 2015 00:29:13 -0700 (PDT)
Received: from xps13.localnet (136-92-190-109.dsl.ovh.fr. [109.190.92.136])
 by smtp.gmail.com with ESMTPSA id hn2sm7246446wjc.45.2015.07.09.00.29.11
 (version=TLSv1.2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128);
 Thu, 09 Jul 2015 00:29:12 -0700 (PDT)
From: Thomas Monjalon <thomas.monjalon@6wind.com>
To: Tetsuya Mukawa <mukawa@igel.co.jp>
Date: Thu, 09 Jul 2015 09:28:07 +0200
Message-ID: <1854437.Ftu1oaz8Ee@xps13>
Organization: 6WIND
User-Agent: KMail/4.14.8 (Linux/4.0.4-2-ARCH; KDE/4.14.8; x86_64; ; )
In-Reply-To: <1436420764-19513-1-git-send-email-mukawa@igel.co.jp>
References: <8CEF83825BEC744B83065625E567D7C204A46F17@IRSMSX108.ger.corp.intel.com>
 <1436420764-19513-1-git-send-email-mukawa@igel.co.jp>
MIME-Version: 1.0
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="us-ascii"
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 07:29:14 -0000

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."