[dpdk-dev] [PATCH v1] doc: announce API and ABI change for ethdev

[Thomas Monjalon]

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?