From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <ferruh.yigit@intel.com>
Received: from mga05.intel.com (mga05.intel.com [192.55.52.43])
 by dpdk.org (Postfix) with ESMTP id 85F121B84D
 for <dev@dpdk.org>; Fri,  9 Feb 2018 11:18:23 +0100 (CET)
X-Amp-Result: SKIPPED(no attachment in message)
X-Amp-File-Uploaded: False
Received: from orsmga007.jf.intel.com ([10.7.209.58])
 by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;
 09 Feb 2018 02:18:22 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.46,482,1511856000"; d="scan'208";a="16442769"
Received: from silpixa00372839.ir.intel.com (HELO
 silpixa00372839.ger.corp.intel.com) ([10.237.222.154])
 by orsmga007.jf.intel.com with ESMTP; 09 Feb 2018 02:18:20 -0800
From: Ferruh Yigit <ferruh.yigit@intel.com>
To: Neil Horman <nhorman@tuxdriver.com>,
 John McNamara <john.mcnamara@intel.com>,
 Marko Kovacevic <marko.kovacevic@intel.com>
Cc: dev@dpdk.org, Ferruh Yigit <ferruh.yigit@intel.com>,
 Konstantin Ananyev <konstantin.ananyev@intel.com>,
 Stephen Hemminger <stephen@networkplumber.org>,
 Bruce Richardson <bruce.richardson@intel.com>,
 Thomas Monjalon <thomas@monjalon.net>
Date: Fri,  9 Feb 2018 10:18:18 +0000
Message-Id: <20180209101818.70041-1-ferruh.yigit@intel.com>
X-Mailer: git-send-email 2.14.3
In-Reply-To: <20180209101119.69860-1-ferruh.yigit@intel.com>
References: <20180209101119.69860-1-ferruh.yigit@intel.com>
Subject: [dpdk-dev] [PATCH v2] doc: update ethdev APIs to return named
	opaque type
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://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: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Fri, 09 Feb 2018 10:18:24 -0000

Ethdev APIs to add callback return the callback object as "void *",
update return type to actual object type
"struct rte_eth_rxtx_callback *"

Signed-off-by: Ferruh Yigit <ferruh.yigit@intel.com>
---
Cc: Konstantin Ananyev <konstantin.ananyev@intel.com>
Cc: Stephen Hemminger <stephen@networkplumber.org>
Cc: Bruce Richardson <bruce.richardson@intel.com>
Cc: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index bbd9456a7..5cb5a00d2 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -49,6 +49,13 @@ Deprecation Notices
   rte_eth_dev_get_sec_ctx() is using uint8_t for port_id, which should be
   uint16_t.
 
+* ethdev: functions add rx/tx callback will return named opaque type
+  rte_eth_add_rx_callback(), rte_eth_add_first_rx_callback() and
+  rte_eth_add_tx_callback() functions currently return callback object as
+  "void \*" but APIs to delete callbacks get "struct rte_eth_rxtx_callback \*"
+  as parameter. For consistency functions adding callback will return
+  "struct rte_eth_rxtx_callback \*" instead of "void * ".
+
 * 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
-- 
2.14.3