From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga02.intel.com (mga02.intel.com [134.134.136.20]) by dpdk.org (Postfix) with ESMTP id ADD54DE0 for ; Mon, 13 Feb 2017 18:39:12 +0100 (CET) Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Feb 2017 09:39:11 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.35,156,1484035200"; d="scan'208";a="64610628" Received: from sivswdev01.ir.intel.com (HELO localhost.localdomain) ([10.237.217.45]) by fmsmga005.fm.intel.com with ESMTP; 13 Feb 2017 09:39:10 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson Date: Mon, 13 Feb 2017 17:38:30 +0000 Message-Id: <1487007510-710-1-git-send-email-bruce.richardson@intel.com> X-Mailer: git-send-email 1.7.0.7 Subject: [dpdk-dev] [PATCH] doc: add ABI change notification for ring library X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 13 Feb 2017 17:39:13 -0000 Document proposed changes for the rings code in the next release. Signed-off-by: Bruce Richardson --- doc/guides/rel_notes/deprecation.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index b49e0a0..e715fc7 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -8,6 +8,25 @@ API and ABI deprecation notices are to be posted here. Deprecation Notices ------------------- +* ring: Changes are planned to rte_ring APIs in release 17.05. Proposed + changes include: + - Removing build time options for the ring: + CONFIG_RTE_RING_SPLIT_PROD_CONS + CONFIG_RTE_RING_PAUSE_REP_COUNT + - Adding an additional parameter to enqueue functions to return the + amount of free space in the ring + - Adding an additional parameter to dequeue functions to return the + number of remaining elements in the ring + - Removing direct support for watermarks in the rings, since the + additional return value from the enqueue function makes it + unneeded + - Adjusting the return values of the bulk() enq/deq functions to + make them consistent with the burst() equivalents. [Note, parameter + to these functions are changing too, per points above, so compiler + will flag them as needing update in legacy code] + - Updates to some library functions e.g. rte_ring_get_memsize() to + allow for variably-sized ring elements. + * igb_uio: iomem mapping and sysfs files created for iomem and ioport in igb_uio will be removed, because we are able to detect these from what Linux has exposed, like the way we have done with uio-pci-generic. This change -- 2.9.3