From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <wei.dai@intel.com>
Received: from mga03.intel.com (mga03.intel.com [134.134.136.65])
 by dpdk.org (Postfix) with ESMTP id 344AE5911
 for <dev@dpdk.org>; Sun, 30 Apr 2017 06:20:01 +0200 (CEST)
Received: from fmsmga004.fm.intel.com ([10.253.24.48])
 by orsmga103.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 29 Apr 2017 21:20:00 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.37,394,1488873600"; d="scan'208";a="255160266"
Received: from dpdk6.bj.intel.com ([172.16.182.81])
 by fmsmga004.fm.intel.com with ESMTP; 29 Apr 2017 21:19:56 -0700
From: Wei Dai <wei.dai@intel.com>
To: wenzhuo.lu@intel.com, thomas@monjalon.net, harish.patil@cavium.com,
 rasesh.mody@cavium.com, stephen.hurd@broadcom.com,
 ajit.khaparde@broadcom.com, helin.zhang@intel.com,
 konstantin.ananyev@intel.com, jingjing.wu@intel.com, jing.d.chen@intel.com,
 adrien.mazarguil@6wind.com, nelio.laranjeiro@6wind.com,
 bruce.richardson@intel.com, yuanhan.liu@linux.intel.com,
 maxime.coquelin@redhat.com, shepard.siegel@atomicrules.com,
 ed.czeck@atomicrules.com, john.miller@atomicrules.com
Cc: dev@dpdk.org,
	Wei Dai <wei.dai@intel.com>
Date: Sun, 30 Apr 2017 12:11:46 +0800
Message-Id: <1493525507-56304-3-git-send-email-wei.dai@intel.com>
X-Mailer: git-send-email 2.7.4
In-Reply-To: <1493525507-56304-1-git-send-email-wei.dai@intel.com>
References: <1493525507-56304-1-git-send-email-wei.dai@intel.com>
Subject: [dpdk-dev] [PATCH v5 2/3] doc: change type of return value of
	adding MAC addr
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Sun, 30 Apr 2017 04:20:01 -0000

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(+)
 mode change 100644 => 100755 doc/guides/rel_notes/release_17_05.rst

diff --git a/doc/guides/rel_notes/release_17_05.rst b/doc/guides/rel_notes/release_17_05.rst
old mode 100644
new mode 100755
index ad20e86..8850fbe
--- a/doc/guides/rel_notes/release_17_05.rst
+++ b/doc/guides/rel_notes/release_17_05.rst
@@ -481,6 +481,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
 -------------
-- 
2.7.4