diff mbox

[dpdk-dev,v5,7/8] doc: update the release notes for the reserved flags

Message ID 1483514502-32841-8-git-send-email-tiwei.bie@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers

Checks

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

Commit Message

Tiwei Bie Jan. 4, 2017, 7:21 a.m. UTC 
  Add information about the flags reserved for PMD-specific API in
the release notes.

Signed-off-by: Tiwei Bie <tiwei.bie@intel.com>
Acked-by: Wenzhuo Lu <wenzhuo.lu@intel.com>
---
 doc/guides/rel_notes/release_17_02.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
diff mbox

Patch

diff --git a/doc/guides/rel_notes/release_17_02.rst b/doc/guides/rel_notes/release_17_02.rst
index 34dba45..af71f39 100644
--- a/doc/guides/rel_notes/release_17_02.rst
+++ b/doc/guides/rel_notes/release_17_02.rst
@@ -58,6 +58,18 @@  New Features
   MACsec offload support. The declarations of the APIs and the definitions
   of the flags can be found in ``rte_pmd_ixgbe.h``.
 
+* **Reserved flags for PMD to implement the PMD-specific API.**
+
+  Following flags in mbuf and ethdev are reserved for PMD to define its
+  own flags when implementing the PMD-specific API.
+
+  * DEV_RX_OFFLOAD_RESERVED_0
+  * DEV_TX_OFFLOAD_RESERVED_0
+  * RTE_ETH_EVENT_RESERVED_0
+  * PKT_TX_RESERVED_0
+
+  You can refer to ``rte_pmd_ixgbe.h`` for an example.
+
 
 Resolved Issues
 ---------------