[dpdk-dev] [PATCH] doc: release notes 17.08, API change description

[dpdk-dev] [PATCH] doc: release notes 17.08, API change description

[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>
---
 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..6959720 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 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
 -----------
-- 
2.7.5

[dpdk-dev] [PATCH v2] doc: release notes 17.08, API change description

[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>
---

v2: Fixed style errors

 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..7c891b4 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 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
 -----------
-- 
2.7.5

Re: [dpdk-dev] [PATCH v2] doc: release notes 17.08, API change description

[Mcnamara, John]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Radu Nicolau
> Sent: Thursday, July 6, 2017 10:29 AM
> To: dev@dpdk.org
> Cc: thomas@monjalon.net; Nicolau, Radu <radu.nicolau@intel.com>
> Subject: [dpdk-dev] [PATCH v2] 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>
> ---
> 
> v2: Fixed style errors
> 
>  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..7c891b4 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 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:

The above line is indented slightly more than the previous "The following"
line. This causes the second list to be rendered in Html as a sub-list of
the first list. Which I'd guess isn't the intended behavior?

John

[dpdk-dev] [PATCH v3] doc: release notes 17.08, API change description

[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 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
 -----------
-- 
2.7.5

Re: [dpdk-dev] [PATCH v3] doc: release notes 17.08, API change description

[Mcnamara, John]

> -----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>

Re: [dpdk-dev] [PATCH v3] doc: release notes 17.08, API change description

[Thomas Monjalon]

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.

[dpdk-dev] [PATCH v4] doc: release notes 17.08, API change description

[Radu Nicolau]

Added API change description - moved bypass functions
from the rte_ethdev library to ixgbe PMD

Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---

v4: changed library name to rte_ethdev and "APIs" to "functions"

 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..2a035d9 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 following rte_ethdev library functions 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 functions 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
 -----------
-- 
2.7.5

[dpdk-dev] [PATCH v5] doc: release notes 17.08, API change description

[Radu Nicolau]

Added API change description - moved bypass functions
from the rte_ethdev library to ixgbe PMD

Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---

v5: changed library name to rte_ethdev and "APIs" to "functions"

 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..c5e9e51 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_ethdev library to ixgbe PMD**
+
+  * The following rte_ethdev library functions 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 functions 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
 -----------
-- 
2.7.5

[dpdk-dev] [PATCH v6] doc: release notes 17.08, API change description

[Radu Nicolau]

Added API change description - moved bypass functions
from the rte_ethdev library to ixgbe PMD

Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>
---

v6: changed library name to rte_ethdev and "APIs" to "functions", 
    added newline after section.

 doc/guides/rel_notes/release_17_08.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/doc/guides/rel_notes/release_17_08.rst b/doc/guides/rel_notes/release_17_08.rst
index 842f46f..234994e 100644
--- a/doc/guides/rel_notes/release_17_08.rst
+++ b/doc/guides/rel_notes/release_17_08.rst
@@ -144,6 +144,32 @@ API Changes
    Also, make sure to start the actual text at the margin.
    =========================================================
 
+* **Moved bypass functions from the rte_ethdev library to ixgbe PMD**
+
+  * The following rte_ethdev library functions 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 functions 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
 -----------
-- 
2.7.5

Re: [dpdk-dev] [PATCH v6] doc: release notes 17.08, API change description

[Thomas Monjalon]

10/07/2017 13:39, Radu Nicolau:
> Added API change description - moved bypass functions
> from the rte_ethdev library to ixgbe PMD

Fixes: e261265e42a1 ("ethdev: move bypass functions to ixgbe PMD")

> Signed-off-by: Radu Nicolau <radu.nicolau@intel.com>

Applied, thanks