[dpdk-dev,v1] doc: announce API and ABI change for ethdev
Checks
Commit Message
In 17.05 nine rte_eth_dev_* functions will be removed from
librte_ether, renamed and moved to the ixgbe PMD.
Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
doc/guides/rel_notes/deprecation.rst | 61 ++++++++++++++++++++++++++++++++++++
1 file changed, 61 insertions(+)
Comments
2017-01-05 10:44, Bernard Iremonger:
> In 17.05 nine rte_eth_dev_* functions will be removed from
> librte_ether, renamed and moved to the ixgbe PMD.
I agree it is a good move to clean up ethdev API.
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> +* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* functions
> + and move them into the ixgbe PMD:
> +
> + ``rte_eth_dev_bypass_init``
> +
> + ``rte_eth_dev_bypass_state_set``
> +
> + ``rte_eth_dev_bypass_state_show``
> +
> + ``rte_eth_dev_bypass_event_store``
> +
> + ``rte_eth_dev_bypass_event_show``
> +
> + ``rte_eth_dev_wd_timeout_store``
> +
> + ``rte_eth_dev_bypass_wd_timeout_show``
> +
> + ``rte_eth_dev_bypass_ver_show``
> +
> + ``rte_eth_dev_bypass_wd_reset``
> +
> + The following fields will be removed from ``struct eth_dev_ops``:
> +
> + ``bypass_init_t``
> +
> + ``bypass_state_set_t``
> +
> + ``bypass_state_show_t``
> +
> + ``bypass_event_set_t``
> +
> + ``bypass_event_show_t``
> +
> + ``bypass_wd_timeout_set_t``
> +
> + ``bypass_wd_timeout_show_t``
> +
> + ``bypass_ver_show_t``
> +
> + ``bypass_wd_reset_t``
> +
> + The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
> +
> + ``rte_pmd_ixgbe_bypass_init``
> +
> + ``rte_pmd_ixgbe_bypass_state_set``
> +
> + ``rte_pmd_ixgbe_bypass_state_show``
> +
> + ``rte_pmd_ixgbe_bypass_event_set``
> +
> + ``rte_pmd_ixgbe_bypass_event_show``
> +
> + ``rte_pmd_ixgbe_bypass_wd_timeout_set``
> +
> + ``rte_pmd_ixgbe_bypass_wd_timeout_show``
> +
> + ``rte_pmd_ixgbe_bypass_ver_show``
> +
> + ``rte_pmd_ixgbe_bypass_wd_reset``
>
Please could you make it shorter by using commas for listing?
Hi Thomas,
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, January 5, 2017 1:31 PM
> To: Iremonger, Bernard <bernard.iremonger@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v1] doc: announce API and ABI change for
> ethdev
>
> 2017-01-05 10:44, Bernard Iremonger:
> > In 17.05 nine rte_eth_dev_* functions will be removed from
> > librte_ether, renamed and moved to the ixgbe PMD.
>
> I agree it is a good move to clean up ethdev API.
>
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > +* ethdev: for 17.05 it is planned to deprecate the following nine
> > +rte_eth_dev_* functions
> > + and move them into the ixgbe PMD:
> > +
> > + ``rte_eth_dev_bypass_init``
> > +
> > + ``rte_eth_dev_bypass_state_set``
> > +
> > + ``rte_eth_dev_bypass_state_show``
> > +
> > + ``rte_eth_dev_bypass_event_store``
> > +
> > + ``rte_eth_dev_bypass_event_show``
> > +
> > + ``rte_eth_dev_wd_timeout_store``
> > +
> > + ``rte_eth_dev_bypass_wd_timeout_show``
> > +
> > + ``rte_eth_dev_bypass_ver_show``
> > +
> > + ``rte_eth_dev_bypass_wd_reset``
> > +
> > + The following fields will be removed from ``struct eth_dev_ops``:
> > +
> > + ``bypass_init_t``
> > +
> > + ``bypass_state_set_t``
> > +
> > + ``bypass_state_show_t``
> > +
> > + ``bypass_event_set_t``
> > +
> > + ``bypass_event_show_t``
> > +
> > + ``bypass_wd_timeout_set_t``
> > +
> > + ``bypass_wd_timeout_show_t``
> > +
> > + ``bypass_ver_show_t``
> > +
> > + ``bypass_wd_reset_t``
> > +
> > + The functions will be renamed to the following, and moved to the
> ``ixgbe`` PMD:
> > +
> > + ``rte_pmd_ixgbe_bypass_init``
> > +
> > + ``rte_pmd_ixgbe_bypass_state_set``
> > +
> > + ``rte_pmd_ixgbe_bypass_state_show``
> > +
> > + ``rte_pmd_ixgbe_bypass_event_set``
> > +
> > + ``rte_pmd_ixgbe_bypass_event_show``
> > +
> > + ``rte_pmd_ixgbe_bypass_wd_timeout_set``
> > +
> > + ``rte_pmd_ixgbe_bypass_wd_timeout_show``
> > +
> > + ``rte_pmd_ixgbe_bypass_ver_show``
> > +
> > + ``rte_pmd_ixgbe_bypass_wd_reset``
> >
>
> Please could you make it shorter by using commas for listing?
I will use commas for the listing in v2.
Regards,
Bernard.
@@ -79,3 +79,64 @@ Deprecation Notices
PMDs that implement the latter.
Target release for removal of the legacy API will be defined once most
PMDs have switched to rte_flow.
+
+* ethdev: for 17.05 it is planned to deprecate the following nine rte_eth_dev_* functions
+ and move them into the ixgbe PMD:
+
+ ``rte_eth_dev_bypass_init``
+
+ ``rte_eth_dev_bypass_state_set``
+
+ ``rte_eth_dev_bypass_state_show``
+
+ ``rte_eth_dev_bypass_event_store``
+
+ ``rte_eth_dev_bypass_event_show``
+
+ ``rte_eth_dev_wd_timeout_store``
+
+ ``rte_eth_dev_bypass_wd_timeout_show``
+
+ ``rte_eth_dev_bypass_ver_show``
+
+ ``rte_eth_dev_bypass_wd_reset``
+
+ The following fields will be removed from ``struct eth_dev_ops``:
+
+ ``bypass_init_t``
+
+ ``bypass_state_set_t``
+
+ ``bypass_state_show_t``
+
+ ``bypass_event_set_t``
+
+ ``bypass_event_show_t``
+
+ ``bypass_wd_timeout_set_t``
+
+ ``bypass_wd_timeout_show_t``
+
+ ``bypass_ver_show_t``
+
+ ``bypass_wd_reset_t``
+
+ The functions will be renamed to the following, and moved to the ``ixgbe`` PMD:
+
+ ``rte_pmd_ixgbe_bypass_init``
+
+ ``rte_pmd_ixgbe_bypass_state_set``
+
+ ``rte_pmd_ixgbe_bypass_state_show``
+
+ ``rte_pmd_ixgbe_bypass_event_set``
+
+ ``rte_pmd_ixgbe_bypass_event_show``
+
+ ``rte_pmd_ixgbe_bypass_wd_timeout_set``
+
+ ``rte_pmd_ixgbe_bypass_wd_timeout_show``
+
+ ``rte_pmd_ixgbe_bypass_ver_show``
+
+ ``rte_pmd_ixgbe_bypass_wd_reset``