From mboxrd@z Thu Jan 1 00:00:00 1970 From: Pablo de Lara Subject: [PATCH] doc: announce API change for virtual device initialization Date: Mon, 4 Jul 2016 15:50:48 +0100 Message-ID: <1467643848-14780-1-git-send-email-pablo.de.lara.guarch@intel.com> Cc: john.mcnamara@intel.com, Pablo de Lara To: dev@dpdk.org Return-path: Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id DCA5E2C06 for ; Mon, 4 Jul 2016 16:49:05 +0200 (CEST) List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" In order to create a virtual device, user needs to call rte_eal_vdev_init generally, but this function returns 0 on success or negative number if error. Instead, something more useful would be to return the port or device id of the device created, so the user can call rte_eal_vdev_init function and use the device straight away, using the id returned by the function. Signed-off-by: Pablo de Lara --- doc/guides/rel_notes/deprecation.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index f502f86..60cc7c7 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -41,3 +41,8 @@ Deprecation Notices * The mempool functions for single/multi producer/consumer are deprecated and will be removed in 16.11. It is replaced by rte_mempool_generic_get/put functions. + +* The rte_eal_vdev_init function will be changed in 16.11 to return + the port/device id of the device created, instead of 0, when it has been + initialized successfully, so user can use the returned value straight away + to call all the device functions that require that parameter. -- 2.5.0