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 A8E29271 for ; Wed, 13 Dec 2017 16:32:14 +0100 (CET) X-Amp-Result: UNSCANNABLE X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by orsmga101.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 13 Dec 2017 07:32:13 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.45,397,1508828400"; d="scan'208";a="1278627" Received: from bricha3-mobl3.ger.corp.intel.com ([10.237.221.106]) by fmsmga002.fm.intel.com with SMTP; 13 Dec 2017 07:32:10 -0800 Received: by (sSMTP sendmail emulation); Wed, 13 Dec 2017 15:32:09 +0000 Date: Wed, 13 Dec 2017 15:32:09 +0000 From: Bruce Richardson To: Neil Horman Cc: dev@dpdk.org, thomas@monjalon.net, john.mcnamara@intel.com Message-ID: <20171213153209.GA12256@bricha3-MOBL3.ger.corp.intel.com> References: <20171201185628.16261-1-nhorman@tuxdriver.com> <20171213151728.16747-1-nhorman@tuxdriver.com> <20171213151728.16747-6-nhorman@tuxdriver.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <20171213151728.16747-6-nhorman@tuxdriver.com> Organization: Intel Research and Development Ireland Ltd. User-Agent: Mutt/1.9.1 (2017-09-22) Subject: Re: [dpdk-dev] [PATCHv4 5/5] doc: Add ABI __experimental tag documentation 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: Wed, 13 Dec 2017 15:32:16 -0000 On Wed, Dec 13, 2017 at 10:17:28AM -0500, Neil Horman wrote: > Document the need to add the __experimental tag to appropriate functions > > Signed-off-by: Neil Horman > CC: Thomas Monjalon > CC: "Mcnamara, John" > CC: Bruce Richardson > --- > doc/guides/contributing/versioning.rst | 9 +++++++++ > 1 file changed, 9 insertions(+) > > diff --git a/doc/guides/contributing/versioning.rst b/doc/guides/contributing/versioning.rst > index 400090628..53f56397e 100644 > --- a/doc/guides/contributing/versioning.rst > +++ b/doc/guides/contributing/versioning.rst > @@ -50,6 +50,15 @@ those new APIs and start finding issues with them, new DPDK APIs will be > automatically marked as ``experimental`` to allow for a period of stabilization > before they become part of a tracked ABI. > > +Note that marking an API as experimental is a two step process. To mark an API > +as experimental, the symbols which are desired to be exported must be placed in > +an EXPERIMENTAL version block in the corresponding libraries' version map > +script. Secondly, the corresponding definitions of those exported functions, and > +their forward declarations (in the development header files), must be marked > +with the __experimental tag (see rte_compat.h). The DPDK build makefiles > +preform a check to ensure that the map file and the C code reflect the same > +list of symbols. > + Minor typo s/preform/perform/ > ABI versions, once released, are available until such time as their > deprecation has been noted in the Release Notes for at least one major release > cycle. For example consider the case where the ABI for DPDK 2.0 has been > -- > 2.14.3 >