[dpdk-dev] [PATCH 2/2] ethdev: pre-emptively document rte_eth_dev_reset error code

[Thomas Monjalon]

19/10/2017 16:53, Remy Horton:
> 
> On 19/10/2017 14:48, luca.boccassi at gmail.com wrote:
> > Document it immediately even if it's not yet supported, so that users
> > and developers can already take into account about this use case, and
> > thus avoid an API-incompatible change later on.
> 
> I'm not sure about documenting unimplemented features, as API docs ought 
> to describe what the code currently does. Then again reason seems OK and 
> I don't think there's hard guidelines on this..

An API does not need to be implemented to describe its behaviour.
We just have to agree about which behaviour we want to expect.

It seems this error code is reasonable.
But I am not sure you need to give the details about the cause
of the error. The most important is to advise app writer to retry
resetting later when the device is ready. Isn't it?