From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH v3] doc: release notes 17.08,
	API change description
Date: Sat, 08 Jul 2017 18:23:16 +0200
Message-ID: <5432382.WhOxQu804y@xps>
References: <1499333341-10875-1-git-send-email-radu.nicolau@intel.com>
 <1499419277-19178-1-git-send-email-radu.nicolau@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, john.mcnamara@intel.com
To: Radu Nicolau <radu.nicolau@intel.com>
Return-path: <dev-bounces@dpdk.org>
Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com
 [66.111.4.26]) by dpdk.org (Postfix) with ESMTP id BCB6F20F
 for <dev@dpdk.org>; Sat,  8 Jul 2017 18:23:17 +0200 (CEST)
In-Reply-To: <1499419277-19178-1-git-send-email-radu.nicolau@intel.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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.