[dpdk-dev] doc: include ixgbe rx error changes

Message ID 1450181430-11412-1-git-send-email-harry.van.haaren@intel.com (mailing list archive)
State Accepted, archived
Headers

Commit Message

Van Haaren, Harry Dec. 15, 2015, 12:10 p.m. UTC
  This patch updates the release notes to include the changes
made (by me), which were not appropriatly documented at the time.
Hence, this patch fixes a number of missing docs,

Fixes: e81a315e5dc5 ("ixgbe: add MAC short packet discard count to Rx errors")
Fixes: 48dd1a82a615 ("ixgbe: remove mac fault counts from Rx errors")
Fixes: 256ff05a9cae ("ixgbe: fix Rx errors statistics for UDP checksum")

Also, the CRC byte removal was not added to release notes, so
Fixes: 156c5a8cf913 ("e1000: remove CRC size from byte counters")
Fixes: c03fcee9abbd ("ixgbe: remove CRC size from byte counters")
Fixes: 0834d1524dee ("i40e: remove CRC size from byte counters")

Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>

---
Apologies for the oversight - I have a cheat-sheet now :)

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

Comments

Thomas Monjalon Dec. 15, 2015, 12:48 p.m. UTC | #1
> > This patch updates the release notes to include the changes made (by me),
> > which were not appropriatly documented at the time.
> > Hence, this patch fixes a number of missing docs,
> > 
> > Fixes: e81a315e5dc5 ("ixgbe: add MAC short packet discard count to Rx
> > errors")
> > Fixes: 48dd1a82a615 ("ixgbe: remove mac fault counts from Rx errors")
> > Fixes: 256ff05a9cae ("ixgbe: fix Rx errors statistics for UDP checksum")
> > 
> > Also, the CRC byte removal was not added to release notes, so
> > Fixes: 156c5a8cf913 ("e1000: remove CRC size from byte counters")
> > Fixes: c03fcee9abbd ("ixgbe: remove CRC size from byte counters")
> > Fixes: 0834d1524dee ("i40e: remove CRC size from byte counters")
> > 
> > Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks
  
John McNamara Dec. 15, 2015, 12:48 p.m. UTC | #2
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Harry van Haaren
> Sent: Tuesday, December 15, 2015 12:11 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH] doc: include ixgbe rx error changes
> 
> This patch updates the release notes to include the changes made (by me),
> which were not appropriatly documented at the time.
> Hence, this patch fixes a number of missing docs,
> 
> Fixes: e81a315e5dc5 ("ixgbe: add MAC short packet discard count to Rx
> errors")
> Fixes: 48dd1a82a615 ("ixgbe: remove mac fault counts from Rx errors")
> Fixes: 256ff05a9cae ("ixgbe: fix Rx errors statistics for UDP checksum")
> 
> Also, the CRC byte removal was not added to release notes, so
> Fixes: 156c5a8cf913 ("e1000: remove CRC size from byte counters")
> Fixes: c03fcee9abbd ("ixgbe: remove CRC size from byte counters")
> Fixes: 0834d1524dee ("i40e: remove CRC size from byte counters")
> 
> Signed-off-by: Harry van Haaren <harry.van.haaren@intel.com>

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

Patch

diff --git a/doc/guides/rel_notes/release_2_2.rst b/doc/guides/rel_notes/release_2_2.rst
index 1ad5891..bb7d15a 100644
--- a/doc/guides/rel_notes/release_2_2.rst
+++ b/doc/guides/rel_notes/release_2_2.rst
@@ -341,6 +341,8 @@  Drivers
 
   Assign a random MAC address in VF when not assigned by PF.
 
+* **igb: Removed CRC bytes from byte counter statistics.**
+
 * **ixgbe: Fixed issue with X550 DCB.**
 
   Fixed a DCB issue with x550 where for 8 TCs (Traffic Classes), if a packet
@@ -361,6 +363,17 @@  Drivers
   packets have to be sent. As part of that fix, ``tx_rs_thresh`` for ixgbe PMD
   is not allowed to be greater then to 32 to comply with HW restrictions.
 
+* **ixgbe: Fixed rx error statistic counter.**
+
+  Fixed an issue that the rx error counter of ixgbe was not accurate. The
+  mac short packet discard count (mspdc) was added to the counter. Mac local
+  faults and mac remote faults are removed as they do not count packets but
+  errors, and jabber errors were removed as they are already accounted for
+  by the CRC error counter. Finally the XEC (l3 / l4 checksum error) counter
+  was removed due to errata, see commit 256ff05a9cae for details.
+
+* **ixgbe: Removed CRC bytes from byte counter statistics.**
+
 * **i40e: Fixed base driver allocation when not using first numa node.**
 
   Fixed i40e issue that occurred when a DPDK application didn't initialize
@@ -382,6 +395,8 @@  Drivers
   Fixed an issue of not freeing a memzone in the call to free the memory for
   adminq DMA.
 
+* **i40e: Removed CRC bytes from byte counter statistics.**
+
 * **mlx: Fixed driver loading.**
 
   The mlx drivers were unable to load when built as a shared library,