doc: sort features in release notes
[dpdk.git] / doc / guides / rel_notes / deprecation.rst
index 1a07f88..8be55c6 100644 (file)
@@ -34,6 +34,9 @@ Deprecation Notices
   remove it from the externally visible ABI and allow it to be updated in the
   future.
 
+* eal: The ``rte_dev_event`` structure will be made private to the EAL as no
+  public API makes use of it.
+
 * rte_atomicNN_xxx: These APIs do not take memory order parameter. This does
   not allow for writing optimized code for all the CPU architectures supported
   in DPDK. DPDK will adopt C11 atomic operations semantics and provide wrappers
@@ -160,6 +163,11 @@ Deprecation Notices
   In 19.11 PMDs will still update the field even when the offload is not
   enabled.
 
+* ethdev: Add new fields to ``rte_eth_rxconf`` to configure the receiving
+  queues to split ingress packets into multiple segments according to the
+  specified lengths into the buffers allocated from the specified
+  memory pools. The backward compatibility to existing API is preserved.
+
 * ethdev: ``rx_descriptor_done`` dev_ops and ``rte_eth_rx_descriptor_done``
   will be deprecated in 20.11 and will be removed in 21.11.
   Existing ``rte_eth_rx_descriptor_status`` and ``rte_eth_tx_descriptor_status``
@@ -171,6 +179,16 @@ Deprecation Notices
   as deprecated in DPDK 20.11, along with the associated macros ``ETH_MIRROR_*``.
   This API will be fully removed in DPDK 21.11.
 
+* ethdev: The ``struct rte_flow_item_eth`` and ``struct rte_flow_item_vlan``
+  structs will be modified, to include an additional value, indicating existence
+  or absence of a VLAN header following the current header, as proposed in RFC
+  https://mails.dpdk.org/archives/dev/2020-August/177536.html.
+
+* ethdev: The ``struct rte_flow_item_ipv6`` struct will be modified to include
+  additional values, indicating existence or absence of IPv6 extension headers
+  following the IPv6 header, as proposed in RFC
+  https://mails.dpdk.org/archives/dev/2020-August/177257.html.
+
 * ethdev: Some internal APIs for driver usage are exported in the .map file.
   Now DPDK has ``__rte_internal`` marker so we can mark internal APIs and move
   them to the INTERNAL block in .map. Although these APIs are internal it will
@@ -187,6 +205,18 @@ Deprecation Notices
 * pmd_dpaa: The API ``rte_pmd_dpaa_set_tx_loopback`` will have extended
   ``port_id`` definition from ``uint8_t`` to ``uint16_t``.
 
+* security: The API ``rte_security_session_create`` takes only single mempool
+  for session and session private data. So the application need to create
+  mempool for twice the number of sessions needed and will also lead to
+  wastage of memory as session private data need more memory compared to session.
+  Hence the API will be modified to take two mempool pointers - one for session
+  and one for private data.
+
+* cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
+  ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
+  ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm``
+  will be removed.
+
 * cryptodev: support for using IV with all sizes is added, J0 still can
   be used but only when IV length in following structs ``rte_crypto_auth_xform``,
   ``rte_crypto_aead_xform`` is set to zero. When IV length is greater or equal
@@ -213,6 +243,10 @@ Deprecation Notices
   ``rte_rawdev_configure``, ``rte_rawdev_queue_conf_get`` and
   ``rte_rawdev_queue_setup``.
 
+* acl: ``RTE_ACL_CLASSIFY_NUM`` enum value will be removed.
+  This enum value is not used inside DPDK, while it prevents to add new
+  classify algorithms without causing an ABI breakage.
+
 * sched: To allow more traffic classes, flexible mapping of pipe queues to
   traffic classes, and subport level configuration of pipes and queues
   changes will be made to macros, data structures and API functions defined
@@ -232,3 +266,8 @@ Deprecation Notices
   Python 2 support will be completely removed in 20.11.
   In 20.08, explicit deprecation warnings will be displayed when running
   scripts with Python 2.
+
+* dpdk-setup.sh: This old script relies on deprecated stuff, and especially
+  ``make``. Given environments are too much variables for such a simple script,
+  it will be removed in DPDK 20.11.
+  Some useful parts may be converted into specific scripts.