mbuf: rename Tx VLAN flags
authorOlivier Matz <olivier.matz@6wind.com>
Fri, 26 Jan 2018 08:35:43 +0000 (09:35 +0100)
committerOlivier Matz <olivier.matz@6wind.com>
Fri, 26 Jan 2018 10:22:57 +0000 (11:22 +0100)
For consistency with the Rx flags, the flags PKT_TX_VLAN_PKT and
PKT_TX_QINQ_PKT are respectively renamed as PKT_TX_VLAN and
PKT_TX_QINQ. The old defines are deprecated but will stay for some time
for compatibility.

Reported-by: Morten Brørup <mb@smartsharesystems.com>
Signed-off-by: Olivier Matz <olivier.matz@6wind.com>
doc/guides/rel_notes/deprecation.rst
lib/librte_mbuf/rte_mbuf.h

index 9a91147..7f78ee9 100644 (file)
@@ -66,3 +66,7 @@ Deprecation Notices
   ``rte_is_ctrlmbuf()`` macro and ``CTRL_MBUF_FLAG`` macro) will be
   removed in v18.05. The packet mbuf API should be used as a
   replacement.
+
+* mbuf: The mbuf flags ``PKT_TX_VLAN_PKT`` and ``PKT_TX_QINQ_PKT`` are
+  respectively renamed as ``PKT_TX_VLAN`` and ``PKT_TX_QINQ``. The old
+  names will be removed in v18.08.
index 7835a2b..4519fb3 100644 (file)
@@ -244,7 +244,9 @@ extern "C" {
 /**
  * Second VLAN insertion (QinQ) flag.
  */
-#define PKT_TX_QINQ_PKT    (1ULL << 49)   /**< TX packet with double VLAN inserted. */
+#define PKT_TX_QINQ        (1ULL << 49)   /**< TX packet with double VLAN inserted. */
+/* this old name is deprecated */
+#define PKT_TX_QINQ_PKT    PKT_TX_QINQ
 
 /**
  * TCP segmentation offload. To enable this offload feature for a
@@ -305,7 +307,12 @@ extern "C" {
  */
 #define PKT_TX_IPV6          (1ULL << 56)
 
-#define PKT_TX_VLAN_PKT      (1ULL << 57) /**< TX packet is a 802.1q VLAN packet. */
+/**
+ * TX packet is a 802.1q VLAN packet.
+ */
+#define PKT_TX_VLAN          (1ULL << 57)
+/* this old name is deprecated */
+#define PKT_TX_VLAN_PKT      PKT_TX_VLAN
 
 /**
  * Offload the IP checksum of an external header in the hardware. The