[dpdk-dev,v3] doc: release notes 17.08, API change description
Checks
Commit Message
Added API change description - moved bypass functions
from the rte_ether library to ixgbe PMD
Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---
v3: fixed indentation issue
doc/guides/rel_notes/release_17_08.rst | 25 +++++++++++++++++++++++++
1 file changed, 25 insertions(+)
Comments
> -----Original Message-----
> From: Nicolau, Radu
> Sent: Friday, July 7, 2017 10:21 AM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; Mcnamara, John <john.mcnamara@intel.com>;
> Nicolau, Radu <radu.nicolau@intel.com>
> Subject: [PATCH v3] doc: release notes 17.08, API change description
>
> Added API change description - moved bypass functions from the rte_ether
> library to ixgbe PMD
>
> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
Hi,
07/07/2017 11:21, Radu Nicolau:
> Added API change description - moved bypass functions
> from the rte_ether library to ixgbe PMD
>
> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
> ---
>
> v3: fixed indentation issue
>
> doc/guides/rel_notes/release_17_08.rst | 25 +++++++++++++++++++++++++
> 1 file changed, 25 insertions(+)
>
> diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst
> index 842f46f..3b371d3 100644
> --- a/doc/guides/rel_notes/release_17_08.rst
> +++ b/doc/guides/rel_notes/release_17_08.rst
> @@ -144,6 +144,31 @@ API Changes
> Also, make sure to start the actual text at the margin.
> =========================================================
>
> +* **Moved bypass functions from the rte_ether library to ixgbe PMD**
The library name is not rte_ether but rte_ethdev or just ethdev.
The name rte_ether refers to the directory where the library code
is wrongly located.
> + * The following rte_ether library APIs were removed:
They are all functions, right?
So it's better to replace "APIs" by "functions".
> +
> + * ``rte_eth_dev_bypass_event_show``
> + * ``rte_eth_dev_bypass_event_store``
> + * ``rte_eth_dev_bypass_init``
> + * ``rte_eth_dev_bypass_state_set``
> + * ``rte_eth_dev_bypass_state_show``
> + * ``rte_eth_dev_bypass_ver_show``
> + * ``rte_eth_dev_bypass_wd_reset``
> + * ``rte_eth_dev_bypass_wd_timeout_show``
> + * ``rte_eth_dev_wd_timeout_store``
> +
> + * The following ixgbe PMD APIs were added:
> +
> + * ``rte_pmd_ixgbe_bypass_event_show``
> + * ``rte_pmd_ixgbe_bypass_event_store``
> + * ``rte_pmd_ixgbe_bypass_init``
> + * ``rte_pmd_ixgbe_bypass_state_set``
> + * ``rte_pmd_ixgbe_bypass_state_show``
> + * ``rte_pmd_ixgbe_bypass_ver_show``
> + * ``rte_pmd_ixgbe_bypass_wd_reset``
> + * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
> + * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
>
> ABI Changes
> -----------
A newline is missing before next section.
@@ -144,6 +144,31 @@ API Changes
Also, make sure to start the actual text at the margin.
=========================================================
+* **Moved bypass functions from the rte_ether library to ixgbe PMD**
+
+ * The following rte_ether library APIs were removed:
+
+ * ``rte_eth_dev_bypass_event_show``
+ * ``rte_eth_dev_bypass_event_store``
+ * ``rte_eth_dev_bypass_init``
+ * ``rte_eth_dev_bypass_state_set``
+ * ``rte_eth_dev_bypass_state_show``
+ * ``rte_eth_dev_bypass_ver_show``
+ * ``rte_eth_dev_bypass_wd_reset``
+ * ``rte_eth_dev_bypass_wd_timeout_show``
+ * ``rte_eth_dev_wd_timeout_store``
+
+ * The following ixgbe PMD APIs were added:
+
+ * ``rte_pmd_ixgbe_bypass_event_show``
+ * ``rte_pmd_ixgbe_bypass_event_store``
+ * ``rte_pmd_ixgbe_bypass_init``
+ * ``rte_pmd_ixgbe_bypass_state_set``
+ * ``rte_pmd_ixgbe_bypass_state_show``
+ * ``rte_pmd_ixgbe_bypass_ver_show``
+ * ``rte_pmd_ixgbe_bypass_wd_reset``
+ * ``rte_pmd_ixgbe_bypass_wd_timeout_show``
+ * ``rte_pmd_ixgbe_bypass_wd_timeout_store``
ABI Changes
-----------