diff mbox

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

Message ID 1499333341-10875-1-git-send-email-radu.nicolau@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Radu Nicolau July 6, 2017, 9:29 a.m. UTC 
  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(+)

Comments

John McNamara July 6, 2017, 3:25 p.m. UTC | #1 
> -----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
diff mbox

Patch

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