From: Luca Boccassi <bluca@debian.org>
To: Thomas Monjalon <thomas@monjalon.net>,
Remy Horton <remy.horton@intel.com>
Cc: dev@dpdk.org, wenzhuo.lu@intel.com, wei.dai@intel.com
Subject: Re: [dpdk-dev] [PATCH 2/2] ethdev: pre-emptively document rte_eth_dev_reset error code
Date: Tue, 24 Oct 2017 13:00:28 +0100 [thread overview]
Message-ID: <1508846428.29685.18.camel@debian.org> (raw)
In-Reply-To: <3757028.oCNDDIN3Jm@xps>
On Tue, 2017-10-24 at 00:11 +0200, Thomas Monjalon wrote:
> 19/10/2017 16:53, Remy Horton:
> >
> > On 19/10/2017 14:48, luca.boccassi@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?
Sure, makes sense, see v2.
--
Kind regards,
Luca Boccassi
next prev parent reply other threads:[~2017-10-24 12:00 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-10-19 13:48 [dpdk-dev] [PATCH 1/2] ethdev: document rte_eth_dev_reset return codes luca.boccassi
2017-10-19 13:48 ` [dpdk-dev] [PATCH 2/2] ethdev: pre-emptively document rte_eth_dev_reset error code luca.boccassi
2017-10-19 14:53 ` Remy Horton
2017-10-19 16:14 ` Luca Boccassi
2017-10-24 6:18 ` Remy Horton
2017-10-24 12:01 ` Luca Boccassi
2017-10-23 22:11 ` Thomas Monjalon
2017-10-24 12:00 ` Luca Boccassi [this message]
2017-10-19 14:52 ` [dpdk-dev] [PATCH 1/2] ethdev: document rte_eth_dev_reset return codes Remy Horton
2017-10-24 11:03 ` [dpdk-dev] [PATCH v2 " luca.boccassi
2017-10-24 11:03 ` [dpdk-dev] [PATCH v2 2/2] ethdev: pre-emptively document rte_eth_dev_reset error code luca.boccassi
2017-10-24 12:29 ` Thomas Monjalon
2017-10-24 12:27 ` [dpdk-dev] [PATCH v2 1/2] ethdev: document rte_eth_dev_reset return codes Thomas Monjalon
2017-10-24 13:19 ` Luca Boccassi
2017-10-24 13:19 ` [dpdk-dev] [PATCH v3 1/2] ethdev: document error codes of reset luca.boccassi
2017-10-24 13:19 ` [dpdk-dev] [PATCH v3 2/2] ethdev: document new error code for reset luca.boccassi
2017-10-24 20:41 ` [dpdk-dev] [PATCH v3 1/2] ethdev: document error codes of reset Ferruh Yigit
2017-10-25 12:01 ` Luca Boccassi
2017-10-25 16:08 ` Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1508846428.29685.18.camel@debian.org \
--to=bluca@debian.org \
--cc=dev@dpdk.org \
--cc=remy.horton@intel.com \
--cc=thomas@monjalon.net \
--cc=wei.dai@intel.com \
--cc=wenzhuo.lu@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).