[dpdk-dev,v7,2/3] doc: change type of return value of adding MAC addr

Message ID 1493944802-52943-3-git-send-email-wei.dai@intel.com (mailing list archive)
State Rejected, archived
Headers

Checks

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

Commit Message

Wei Dai May 5, 2017, 12:40 a.m. UTC
  Add following lines in section of API change in release note.

If a MAC address fails to be added without this change, it is still
stored and may be regarded as a valid one. This may lead to errors
in application. The type of return value of eth_mac_addr_add_t in
rte_ethdev.h is changed. Any specific NIC also follows this change.

Signed-off-by: Wei Dai <wei.dai@intel.com>
Acked-by: John McNamara <john.mcnamara@intel.com>
---
 doc/guides/rel_notes/release_17_05.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Thomas Monjalon May 5, 2017, 2:23 p.m. UTC | #1
05/05/2017 02:40, Wei Dai:
> Add following lines in section of API change in release note.
> 
> If a MAC address fails to be added without this change, it is still
> stored and may be regarded as a valid one. This may lead to errors
> in application. The type of return value of eth_mac_addr_add_t in
> rte_ethdev.h is changed. Any specific NIC also follows this change.
> 
> Signed-off-by: Wei Dai <wei.dai@intel.com>
> Acked-by: John McNamara <john.mcnamara@intel.com>

This patch is rejected because it is neither an API nor an ABI change.
  

Patch

diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst
index 4b47ae1..0bd07f1 100644
--- a/doc/guides/rel_notes/release_17_05.rst
+++ b/doc/guides/rel_notes/release_17_05.rst
@@ -489,6 +489,13 @@  ABI Changes
 * The ``rte_cryptodev_info.sym`` structure has new field ``max_nb_sessions_per_qp``
   to support drivers which may support limited number of sessions per queue_pair.
 
+* **Return if the MAC address is added successfully or not.**
+
+  If a MAC address fails to be added without this change, it is still stored
+  and may be regarded as a valid one. This may lead to errors in application.
+  The type of return value of eth_mac_addr_add_t in rte_ethdev.h is changed.
+  Any specific NIC also follows this change.
+
 
 Removed Items
 -------------