Re: [dpdk-dev] [PATCH v4 1/3] lib/librte_ether: add support for port reset

[Thomas Monjalon <thomas@monjalon.net>]

24/04/2017 05:39, Zhao1, Wei:
> Hi, yuanhan & thomas
> From: Yuanhan Liu [mailto:yuanhan.liu@linux.intel.com]
> > On Fri, Apr 21, 2017 at 11:28:37AM +0200, Thomas Monjalon wrote:
> > > > Maybe I should add some words in doc\guides\nics\i40e.rst to Record
> > > > which configurations are  saved  and restored by the PMD driver in
> > > > reset function. Which not list in that are recognized as not saved
> > > > and restored by default. OTHER  NIC for this feature can add similar
> > > > record in their xxx.rst.
> > > 
> > > No, when defining a generic API in ethdev, we must define the same
> > > behaviour for every drivers.
> > 
> > Agreed. That was my point.
> > 
> > 	--yliu
> > 	
> > > Please check how to make the behaviour consistent and documented in
> > > ethdev. We may need to document your new function and start/stop also.
> 
> Do you have any suggestion on which document  in rte layer to record store
> and restore info by me?

It should be documented in the doxygen comment of the functions.
Either we explain which configuration is restored on start and reset,
or we state everything (or nothing) is restored except the configurations
commented in the related configuration functions.