[dpdk-dev] [PATCH] doc: Fix doxygen comments of rte_eth_dev_close() and rte_eth_dev_detach()

Tetsuya Mukawa mukawa at igel.co.jp
Thu Jul 9 10:10:08 CEST 2015


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 at 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


More information about the dev mailing list