diff mbox

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

Message ID 9d7b6d0a867a27f6702d5b13a24cf54555ea49f0.1492071245.git.wei.dai@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

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

Commit Message

Wei Dai April 13, 2017, 8:21 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>
---
 doc/guides/rel_notes/release_17_05.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

John McNamara April 14, 2017, 4:03 p.m. UTC | #1 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Wei Dai
> Sent: Thursday, April 13, 2017 9:21 AM
> To: thomas.monjalon@6wind.com; harish.patil@cavium.com;
> rasesh.mody@cavium.com; stephen.hurd@broadcom.com;
> ajit.khaparde@broadcom.com; Lu, Wenzhuo <wenzhuo.lu@intel.com>; Zhang,
> Helin <helin.zhang@intel.com>; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; Wu, Jingjing <jingjing.wu@intel.com>;
> Chen, Jing D <jing.d.chen@intel.com>; adrien.mazarguil@6wind.com;
> nelio.laranjeiro@6wind.com; Richardson, Bruce
> <bruce.richardson@intel.com>; yuanhan.liu@linux.intel.com;
> maxime.coquelin@redhat.com
> Cc: dev@dpdk.org; Dai, Wei <wei.dai@intel.com>
> Subject: [dpdk-dev] [PATCH v4 2/3] doc: change type of return value of
> adding MAC addr
> 
> 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>
diff mbox

Patch

diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst
index 4968b8f..c9ba484 100644
--- a/doc/guides/rel_notes/release_17_05.rst
+++ b/doc/guides/rel_notes/release_17_05.rst
@@ -438,6 +438,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
 -------------