doc: announce removal of LPM memory location

[dpdk.git] / doc / guides / rel_notes / deprecation.rst

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 8e73cc3..da17880 100644 (file)
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -23,6 +23,11 @@ Deprecation Notices
 * The Macros RTE_HASH_BUCKET_ENTRIES_MAX and RTE_HASH_KEY_LENGTH_MAX are
   deprecated and will be removed with version 2.2.
 
+* The function rte_jhash2 is deprecated and should be removed.
+
+* The field mem_location of the rte_lpm structure is deprecated and should be
+  removed as well as the macros RTE_LPM_HEAP and RTE_LPM_MEMZONE.
+
 * Significant ABI changes are planned for struct rte_mbuf, struct rte_kni_mbuf,
   and several ``PKT_RX_`` flags will be removed, to support unified packet type
   from release 2.1. Those changes may be enabled in the upcoming release 2.1
@@ -58,6 +63,12 @@ Deprecation Notices
   the tunnel type, TNI/VNI, inner MAC and inner VLAN are monitored.
   The release 2.2 will contain these changes without backwards compatibility.
 
+* librte_kni: Functions based on port id are deprecated for a long time and
+  should be removed (rte_kni_create, rte_kni_get_port_id and rte_kni_info_get).
+
+* librte_pmd_ring: The deprecated functions rte_eth_ring_pair_create and
+  rte_eth_ring_pair_attach should be removed.
+
 * ABI changes are planned for struct virtio_net in order to support vhost-user
   multiple queues feature.
   It should be integrated in release 2.2 without backward compatibility.
@@ -70,3 +81,31 @@ Deprecation Notices
 
 * The scheduler statistics structure will change to allow keeping track of
   RED actions.
+
+* librte_acl: The structure rte_acl_ipv4vlan_rule is deprecated and should
+  be removed as well as the associated functions rte_acl_ipv4vlan_add_rules
+  and rte_acl_ipv4vlan_build.
+
+* librte_cfgfile: In order to allow for longer names and values,
+  the value of macros CFG_NAME_LEN and CFG_NAME_VAL will be increased.
+  Most likely, the new values will be 64 and 256, respectively.
+
+* librte_port: Macros to access the packet meta-data stored within the
+  packet buffer will be adjusted to cover the packet mbuf structure as well,
+  as currently they are able to access any packet buffer location except the
+  packet mbuf structure.
+
+* librte_table LPM: A new parameter to hold the table name will be added to
+  the LPM table parameter structure.
+
+* librte_table: New functions for table entry bulk add/delete will be added
+  to the table operations structure.
+
+* librte_table hash: Key mask parameter will be added to the hash table
+  parameter structure for 8-byte key and 16-byte key extendible bucket and
+  LRU tables.
+
+* librte_pipeline: The prototype for the pipeline input port, output port
+  and table action handlers will be updated:
+  the pipeline parameter will be added, the packets mask parameter will be
+  either removed (for input port action handler) or made input-only.