From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thomas Monjalon Subject: Re: [PATCHv4 5/5] doc: Add ABI __experimental tag documentation Date: Sun, 21 Jan 2018 21:14:39 +0100 Message-ID: <3663302.jqOVGB4Z0T@xps> 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-Transfer-Encoding: 7Bit Cc: dev@dpdk.org, john.mcnamara@intel.com, bruce.richardson@intel.com To: Neil Horman Return-path: Received: from out2-smtp.messagingengine.com (out2-smtp.messagingengine.com [66.111.4.26]) by dpdk.org (Postfix) with ESMTP id 34D4BA49C for ; Sun, 21 Jan 2018 21:15:18 +0100 (CET) In-Reply-To: <20171213151728.16747-6-nhorman@tuxdriver.com> List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 13/12/2017 16:17, Neil Horman: > --- a/doc/guides/contributing/versioning.rst > +++ b/doc/guides/contributing/versioning.rst > +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. Thanks for this text. Bruce already commented about the type "preform". Ferruh already commented about adding a string in doxygen header. Ferruh already commented about adding sentences for new API. I add that it would be the right place to explain the effect of the attribute, and how it can be disabled at compilation.