[dpdk-dev,v3,9/9] doc: update release notes
Checks
Commit Message
Add release note for removing set VF API's from the ethdev,
renaming the API's and moving them to the ixgbe PMD.
Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
---
doc/guides/rel_notes/release_17_02.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
Comments
Hi Bernard,
On 12/12/2016 1:50 PM, Bernard Iremonger wrote:
> Add release note for removing set VF API's from the ethdev,
> renaming the API's and moving them to the ixgbe PMD.
Sorry, my bad, I wasn't clear enough.
I was thinking about updating "Shared Library Versions" section of the
release notes, and increasing the librte_ethdev.so version (from 5 to 6)
I believe new feature section does not require an update.
If you don't mind I can update library version with previous patch, and
you don't need to send a new version of the patch. Please let me know.
>
> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> ---
> doc/guides/rel_notes/release_17_02.rst | 20 ++++++++++++++++++++
> 1 file changed, 20 insertions(+)
>
> diff --git a/doc/guides/rel_notes/release_17_02.rst b/doc/guides/rel_notes/release_17_02.rst
> index 3b65038..d30b258 100644
> --- a/doc/guides/rel_notes/release_17_02.rst
> +++ b/doc/guides/rel_notes/release_17_02.rst
> @@ -38,6 +38,26 @@ New Features
> Also, make sure to start the actual text at the margin.
> =========================================================
>
> +* **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
> +
> + The following five APIs for VF management from the PF have been removed from the ethdev,
> + renamed and added to the ixgbe PMD::
> +
> + rte_eth_dev_set_vf_rate_limit
> + rte_eth_dev_set_vf_rx
> + rte_eth_dev_set_vf_rxmode
> + rte_eth_dev_set_vf_tx
> + rte_eth_dev_set_vf_vlan_filter
> +
> + The API's have been renamed to the following::
> +
> + rte_pmd_ixgbe_set_vf_rate_limit
> + rte_pmd_ixgbe_set_vf_rx
> + rte_pmd_ixgbe_set_vf_rxmode
> + rte_pmd_ixgbe_set_vf_tx
> + rte_pmd_ixgbe_set_vf_vlan_filter
> +
> + The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
>
> Resolved Issues
> ---------------
>
Hi Ferruh,
> -----Original Message-----
> From: Yigit, Ferruh
> Sent: Monday, December 12, 2016 3:52 PM
> To: Iremonger, Bernard <bernard.iremonger@intel.com>;
> thomas.monjalon@6wind.com; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH v3 9/9] doc: update release notes
>
> Hi Bernard,
>
> On 12/12/2016 1:50 PM, Bernard Iremonger wrote:
> > Add release note for removing set VF API's from the ethdev, renaming
> > the API's and moving them to the ixgbe PMD.
>
> Sorry, my bad, I wasn't clear enough.
>
> I was thinking about updating "Shared Library Versions" section of the
> release notes, and increasing the librte_ethdev.so version (from 5 to 6) I
> believe new feature section does not require an update.
>
> If you don't mind I can update library version with previous patch, and you
> don't need to send a new version of the patch. Please let me know.
Yes, that's fine with me.
> >
> > Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
> > ---
> > doc/guides/rel_notes/release_17_02.rst | 20 ++++++++++++++++++++
> > 1 file changed, 20 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/release_17_02.rst
> > b/doc/guides/rel_notes/release_17_02.rst
> > index 3b65038..d30b258 100644
> > --- a/doc/guides/rel_notes/release_17_02.rst
> > +++ b/doc/guides/rel_notes/release_17_02.rst
> > @@ -38,6 +38,26 @@ New Features
> > Also, make sure to start the actual text at the margin.
> >
> =========================================================
> >
> > +* **Moved five APIs for VF management from the ethdev to the ixgbe
> > +PMD.**
> > +
> > + The following five APIs for VF management from the PF have been
> > + removed from the ethdev, renamed and added to the ixgbe PMD::
> > +
> > + rte_eth_dev_set_vf_rate_limit
> > + rte_eth_dev_set_vf_rx
> > + rte_eth_dev_set_vf_rxmode
> > + rte_eth_dev_set_vf_tx
> > + rte_eth_dev_set_vf_vlan_filter
> > +
> > + The API's have been renamed to the following::
> > +
> > + rte_pmd_ixgbe_set_vf_rate_limit
> > + rte_pmd_ixgbe_set_vf_rx
> > + rte_pmd_ixgbe_set_vf_rxmode
> > + rte_pmd_ixgbe_set_vf_tx
> > + rte_pmd_ixgbe_set_vf_vlan_filter
> > +
> > + The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
> >
> > Resolved Issues
> > ---------------
> >
Regards,
Bernard.
On 12/12/2016 3:55 PM, Iremonger, Bernard wrote:
> Hi Ferruh,
>
>
>> -----Original Message-----
>> From: Yigit, Ferruh
>> Sent: Monday, December 12, 2016 3:52 PM
>> To: Iremonger, Bernard <bernard.iremonger@intel.com>;
>> thomas.monjalon@6wind.com; dev@dpdk.org
>> Subject: Re: [dpdk-dev] [PATCH v3 9/9] doc: update release notes
>>
>> Hi Bernard,
>>
>> On 12/12/2016 1:50 PM, Bernard Iremonger wrote:
>>> Add release note for removing set VF API's from the ethdev, renaming
>>> the API's and moving them to the ixgbe PMD.
>>
>> Sorry, my bad, I wasn't clear enough.
>>
>> I was thinking about updating "Shared Library Versions" section of the
>> release notes, and increasing the librte_ethdev.so version (from 5 to 6) I
>> believe new feature section does not require an update.
>>
>> If you don't mind I can update library version with previous patch, and you
>> don't need to send a new version of the patch. Please let me know.
>
> Yes, that's fine with me.
It seems already increased for this release, by another patch, so no
change required there.
I will move your release notes changes to "API Changes" section.
>
>
>>>
>>> Signed-off-by: Bernard Iremonger <bernard.iremonger@intel.com>
>>> ---
>>> doc/guides/rel_notes/release_17_02.rst | 20 ++++++++++++++++++++
>>> 1 file changed, 20 insertions(+)
>>>
>>> diff --git a/doc/guides/rel_notes/release_17_02.rst
>>> b/doc/guides/rel_notes/release_17_02.rst
>>> index 3b65038..d30b258 100644
>>> --- a/doc/guides/rel_notes/release_17_02.rst
>>> +++ b/doc/guides/rel_notes/release_17_02.rst
>>> @@ -38,6 +38,26 @@ New Features
>>> Also, make sure to start the actual text at the margin.
>>>
>> =========================================================
>>>
>>> +* **Moved five APIs for VF management from the ethdev to the ixgbe
>>> +PMD.**
>>> +
>>> + The following five APIs for VF management from the PF have been
>>> + removed from the ethdev, renamed and added to the ixgbe PMD::
>>> +
>>> + rte_eth_dev_set_vf_rate_limit
>>> + rte_eth_dev_set_vf_rx
>>> + rte_eth_dev_set_vf_rxmode
>>> + rte_eth_dev_set_vf_tx
>>> + rte_eth_dev_set_vf_vlan_filter
>>> +
>>> + The API's have been renamed to the following::
>>> +
>>> + rte_pmd_ixgbe_set_vf_rate_limit
>>> + rte_pmd_ixgbe_set_vf_rx
>>> + rte_pmd_ixgbe_set_vf_rxmode
>>> + rte_pmd_ixgbe_set_vf_tx
>>> + rte_pmd_ixgbe_set_vf_vlan_filter
>>> +
>>> + The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
>>>
>>> Resolved Issues
>>> ---------------
>>>
> Regards,
>
> Bernard.
>
@@ -38,6 +38,26 @@ New Features
Also, make sure to start the actual text at the margin.
=========================================================
+* **Moved five APIs for VF management from the ethdev to the ixgbe PMD.**
+
+ The following five APIs for VF management from the PF have been removed from the ethdev,
+ renamed and added to the ixgbe PMD::
+
+ rte_eth_dev_set_vf_rate_limit
+ rte_eth_dev_set_vf_rx
+ rte_eth_dev_set_vf_rxmode
+ rte_eth_dev_set_vf_tx
+ rte_eth_dev_set_vf_vlan_filter
+
+ The API's have been renamed to the following::
+
+ rte_pmd_ixgbe_set_vf_rate_limit
+ rte_pmd_ixgbe_set_vf_rx
+ rte_pmd_ixgbe_set_vf_rxmode
+ rte_pmd_ixgbe_set_vf_tx
+ rte_pmd_ixgbe_set_vf_vlan_filter
+
+ The declarations for the API’s can be found in ``rte_pmd_ixgbe.h``.
Resolved Issues
---------------