[dpdk-dev] doc: update the dpdk 2.2 release notes

Message ID 1442322474-27380-1-git-send-email-john.mcnamara@intel.com (mailing list archive)
State Superseded, archived
Headers

Commit Message

John McNamara Sept. 15, 2015, 1:07 p.m. UTC
  Update the DPDK 2.2 release notes with recent fixes:

  7e01e3 i40e: fix base driver allocation when not using first numa node
  5e73f4 ixgbe: remove burst size restriction of vector Rx
  7fcd13 ixgbe: fix X550 DCB
  d49e0f hash: fix memory allocation of cuckoo key table
  9db649 eal/linux: fix epoll timeout

Signed-off-by: John McNamara <john.mcnamara@intel.com>
---

Authors of the above commits can you please check the associated release note below.


 doc/guides/rel_notes/release_2_2.rst | 31 +++++++++++++++++++++++++++++++
 1 file changed, 31 insertions(+)
  

Comments

Thomas Monjalon Sept. 15, 2015, 1:21 p.m. UTC | #1
2015-09-15 14:07, John McNamara:
> +* **i40e: Fixed base driver allocation when not using first numa node.**
> +
> +Fixed i40e issue that occurred when a DPDK application didn't initialize ports
> +if memory wasn't available on socket 0.
> +
> +
> +* **ixgbe: Removed burst size restriction of vector RX.**
> +
> +Fixed issue where a burst size less than 32 didn't receive anything.
> +
> +
> +* **ixgbe: Fixed issue with X550 DCB.**
> +
> +Fixed a DCB issue with x550 where for 8 TCs (Traffic Classes), if a packet
> +with user priority 6 or 7 was injected to the NIC, then the NIC would only put
> +3 packets into the queue. There was also a similar issue for 4 TCs.
> +
> +
> +* **hash: Fixed memory allocation of Cuckoo Hash key table.**
> +
> +Fixed issue where an incorrect Cuckoo Hash key table size could be calculated
> +limiting the size to 4GB.
> +
> +Fixes: 48a399119619 ("hash: replace with cuckoo hash implementation")
> +
> +
> +* **eal/linux: Fixed epoll timeout.**
> +
> +Fixed issue where the ``rte_epoll_wait()`` function didn't return when the
> +underlying call to ``epoll_wait()`` timed out.


In order to easily read the release notes, I suggest to order items logically,
starting with API (ethdev, cryptodev), EAL, drivers, libs, tools, examples.
Maybe that adding some subtitles would help.
Opinions?
  
David Marchand Sept. 16, 2015, 8:27 a.m. UTC | #2
On Tue, Sep 15, 2015 at 3:07 PM, John McNamara <john.mcnamara@intel.com>
wrote:

> Update the DPDK 2.2 release notes with recent fixes:
>
>   7e01e3 i40e: fix base driver allocation when not using first numa node
>   5e73f4 ixgbe: remove burst size restriction of vector Rx
>   7fcd13 ixgbe: fix X550 DCB
>   d49e0f hash: fix memory allocation of cuckoo key table
>   9db649 eal/linux: fix epoll timeout
>
> Signed-off-by: John McNamara <john.mcnamara@intel.com>
> ---
>
> Authors of the above commits can you please check the associated release
> note below.
>
>
>  doc/guides/rel_notes/release_2_2.rst | 31 +++++++++++++++++++++++++++++++
>  1 file changed, 31 insertions(+)
>
> diff --git a/doc/guides/rel_notes/release_2_2.rst
> b/doc/guides/rel_notes/release_2_2.rst
> index 682f468..9604316 100644
> --- a/doc/guides/rel_notes/release_2_2.rst
> +++ b/doc/guides/rel_notes/release_2_2.rst
> @@ -8,6 +8,37 @@ New Features
>  Resolved Issues
>  ---------------
>
> +* **i40e: Fixed base driver allocation when not using first numa node.**
> +
> +Fixed i40e issue that occurred when a DPDK application didn't initialize
> ports
> +if memory wasn't available on socket 0.
> +
> +
>

Ok for me.
  
John McNamara Sept. 16, 2015, 10:50 a.m. UTC | #3
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, September 15, 2015 2:22 PM
> To: Mcnamara, John
> Cc: dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: update the dpdk 2.2 release notes
>
> ...
>
> In order to easily read the release notes, I suggest to order items
> logically, starting with API (ethdev, cryptodev), EAL, drivers, libs,
> tools, examples.
> Maybe that adding some subtitles would help.
> Opinions?

Hi

I forget to do it with the above section but in the previous release notes I sorted the "Resolved Issues" alphabetically. It isn't a logical ordering but it is reasonably easy to navigate and understand:

http://dpdk.org/doc/guides/rel_notes/release_2_1.html#resolved-issues

Would that be sufficient?

John.
--
  
Thomas Monjalon Sept. 16, 2015, 12:58 p.m. UTC | #4
2015-09-16 10:50, Mcnamara, John:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > In order to easily read the release notes, I suggest to order items
> > logically, starting with API (ethdev, cryptodev), EAL, drivers, libs,
> > tools, examples.
> > Maybe that adding some subtitles would help.
> > Opinions?
> 
> Hi
> 
> I forget to do it with the above section but in the previous release notes I sorted the "Resolved Issues" alphabetically. It isn't a logical ordering but it is reasonably easy to navigate and understand:
> 
> http://dpdk.org/doc/guides/rel_notes/release_2_1.html#resolved-issues
> 
> Would that be sufficient?

To me, reading an alphabetically sorted list of fixes, is like reading
a random list: there is no real logic.
Grouping drivers together seems easier.
Other opinions?
Other people reading the release notes? ;)
  

Patch

diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst
index 682f468..9604316 100644
--- a/doc/guides/rel_notes/release_2_2.rst
+++ b/doc/guides/rel_notes/release_2_2.rst
@@ -8,6 +8,37 @@  New Features
 Resolved Issues
 ---------------
 
+* **i40e: Fixed base driver allocation when not using first numa node.**
+
+Fixed i40e issue that occurred when a DPDK application didn't initialize ports
+if memory wasn't available on socket 0.
+
+
+* **ixgbe: Removed burst size restriction of vector RX.**
+
+Fixed issue where a burst size less than 32 didn't receive anything.
+
+
+* **ixgbe: Fixed issue with X550 DCB.**
+
+Fixed a DCB issue with x550 where for 8 TCs (Traffic Classes), if a packet
+with user priority 6 or 7 was injected to the NIC, then the NIC would only put
+3 packets into the queue. There was also a similar issue for 4 TCs.
+
+
+* **hash: Fixed memory allocation of Cuckoo Hash key table.**
+
+Fixed issue where an incorrect Cuckoo Hash key table size could be calculated
+limiting the size to 4GB.
+
+Fixes: 48a399119619 ("hash: replace with cuckoo hash implementation")
+
+
+* **eal/linux: Fixed epoll timeout.**
+
+Fixed issue where the ``rte_epoll_wait()`` function didn't return when the
+underlying call to ``epoll_wait()`` timed out.
+
 
 Known Issues
 ------------