X-Git-Url: http://git.droids-corp.org/?a=blobdiff_plain;f=doc%2Fguides%2Frel_notes%2Fdeprecation.rst;h=d2dd302db630cbb8add60f4512bfbd138413d184;hb=d8cda718e13ce3b238489217832dc5ed28557206;hp=fd85a141bae78f9f6a0914647c3d992a4593fc2e;hpb=18aee2861a1f8c5f7511fed32ecc59295c26f79a;p=dpdk.git

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index fd85a141ba..d2dd302db6 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -8,6 +8,16 @@ API and ABI deprecation notices are to be posted here.
 Deprecation Notices
 -------------------
 
+* eal: DPDK runtime configuration file (located at
+  ``/var/run/.<prefix>_config``) will be moved. The new path will be as follows:
+
+  - if DPDK is running as root, path will be set to
+    ``/var/run/dpdk/<prefix>/config``
+  - if DPDK is not running as root and $XDG_RUNTIME_DIR is set, path will be set
+    to ``$XDG_RUNTIME_DIR/dpdk/<prefix>/config``
+  - if DPDK is not running as root and $XDG_RUNTIME_DIR is not set, path will be
+    set to ``/tmp/dpdk/<prefix>/config``
+
 * eal: both declaring and identifying devices will be streamlined in v18.05.
   New functions will appear to query a specific port from buses, classes of
   device and device drivers. Device declaration will be made coherent with the
@@ -32,8 +42,8 @@ Deprecation Notices
   mempool names have been defined in ``rte_mbuf`` in v18.02. The uses of
   ``rte_eal_mbuf_default_mempool_ops`` shall be replaced by
   ``rte_mbuf_best_mempool_ops``.
-  The following function is now redundant and it is target to be deprecated
-  in 18.05:
+  The following function is deprecated since 18.05, and will be removed
+  in 18.08:
 
   - ``rte_eal_mbuf_default_mempool_ops``
 
@@ -59,21 +69,34 @@ Deprecation Notices
   Target release for removal of the legacy API will be defined once most
   PMDs have switched to rte_flow.
 
-* ethdev: A work is being planned for 18.05 to expose VF port representors
-  as a mean to perform control and data path operation on the different VFs.
-  As VF representor is an ethdev port, new fields are needed in order to map
-  between the VF representor and the VF or the parent PF. Those new fields
-  are to be included in ``rte_eth_dev_info`` struct.
-
-* i40e: The default flexible payload configuration which extracts the first 16
-  bytes of the payload for RSS will be deprecated starting from 18.02. If
-  required the previous behavior can be configured using existing flow
-  director APIs. There is no ABI/API break. This change will just remove a
-  global configuration setting and require explicit configuration.
-
 * pdump: As we changed to use generic IPC, some changes in APIs and structure
   are expected in subsequent release.
 
   - ``rte_pdump_set_socket_dir`` will be removed;
   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
   - The enum ``rte_pdump_socktype`` will be removed.
+
+* cryptodev: The following changes will be made in the library
+  for 18.08:
+
+  - Removal of ``sym`` structure in ``rte_cryptodev_info`` structure,
+    containing fields not relevant anymore since the session mempool
+    is not internal in the crypto device anymore.
+  - Replacement of ``pci_dev`` field with the more generic ``rte_device``
+    structure.
+  - Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
+    ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
+    18.05 and removed in 18.08, as there are no drivers doing anything useful
+    with them.
+  - Functions ``rte_cryptodev_queue_pair_start()`` and
+    ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05
+    and removed in 18.08, as there are no drivers doing anything useful
+    with them.
+  - Some feature flags such as ``RTE_CRYPTODEV_FF_MBUF_SCATTER_GATHER`` are ambiguous,
+    so some will be replaced by more explicit flags.
+  - Function ``rte_cryptodev_get_header_session_size()`` will be deprecated
+    in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_header_session_size()``.
+    It will be removed in 18.08.
+  - Function ``rte_cryptodev_get_private_session_size()`` will be deprecated
+    in 18.05, and it gets replaced with ``rte_cryptodev_sym_get_private_session_size()``.
+    It will be removed in 18.08.