[v2] doc: add deprecation notice about changes to ethernet structures

Message ID 20190719165631.9235-1-stephen@networkplumber.org
State Accepted, archived
Delegated to: Thomas Monjalon
Headers show
Series
  • [v2] doc: add deprecation notice about changes to ethernet structures
Related show

Checks

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

Commit Message

Stephen Hemminger July 19, 2019, 4:56 p.m.
Tell users about upcoming changes to rte_ether_addr and
rte_ether_header.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
---
v2 - reword and fix spelling

 doc/guides/rel_notes/deprecation.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

Comments

Andrew Rybchenko July 23, 2019, 11:28 a.m. | #1
On 7/19/19 7:56 PM, Stephen Hemminger wrote:
> Tell users about upcoming changes to rte_ether_addr and
> rte_ether_header.
>
> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> Acked-by: Bruce Richardson <bruce.richardson@intel.com>

Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
Ferruh Yigit July 31, 2019, 10:46 a.m. | #2
On 7/23/2019 12:28 PM, Andrew Rybchenko wrote:
> On 7/19/19 7:56 PM, Stephen Hemminger wrote:
>> Tell users about upcoming changes to rte_ether_addr and
>> rte_ether_header.
>>
>> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
>> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> 
> Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
> 

Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
Thomas Monjalon Aug. 6, 2019, 11:26 a.m. | #3
> >> Tell users about upcoming changes to rte_ether_addr and
> >> rte_ether_header.
> >>
> >> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> >> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> > 
> > Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
> 
> Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>

Acked-by: Thomas Monjalon <thomas@monjalon.net>
Thomas Monjalon Aug. 10, 2019, 8:22 p.m. | #4
06/08/2019 13:26, Thomas Monjalon:
> > >> Tell users about upcoming changes to rte_ether_addr and
> > >> rte_ether_header.
> > >>
> > >> Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
> > >> Acked-by: Bruce Richardson <bruce.richardson@intel.com>
> > > 
> > > Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
> > 
> > Acked-by: Ferruh Yigit <ferruh.yigit@intel.com>
> 
> Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a7796f49b9fe..307f831cee60 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -82,3 +82,13 @@  Deprecation Notices
   to set new power environment if power environment was already initialized.
   In this case the function will return -1 unless the environment is unset first
   (using ``rte_power_unset_env``). Other function usage scenarios will not change.
+
+* net: the Ethernet address and header definitions will change
+  attributes. The Ethernet address struct will no longer be marked as
+  packed since the packed attribute is meaningless on a byte
+  array. The Ethernet header will be marked as aligned on a 2-byte
+  boundary and will no longer have the packed attribute. This allows
+  for efficient access on CPU architectures where unaligned access is
+  expensive. These changes should not impact normal usage because drivers
+  naturally align the Ethernet header on receive and all known
+  encapsulations preserve the alignment of the header.