From mboxrd@z Thu Jan 1 00:00:00 1970 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) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id 6FB4F20876; Sun, 21 Jan 2018 15:15:17 -0500 (EST) Received: from frontend2 ([10.202.2.161]) by compute1.internal (MEProxy); Sun, 21 Jan 2018 15:15:17 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:content-transfer-encoding:content-type:date:from:in-reply-to :message-id:mime-version:references:subject:to:x-me-sender :x-me-sender:x-sasl-enc; s=mesmtp; bh=BLMa/pmdHlvtPuGEsIVD2KL4VB ZBuQNZKQGFULJRhU0=; b=Y/x+GL0jAskIWszEEZLn2znguZJPx4EKJGdWxWj9uQ i54lJEuh8qjmStXCO2zP4E45VdaayLLIJ2Jn5UlyMnm+nCkW+zPHd4fgPyVyuHZq 74/HUAcBKXP+JdYrRsRh866r1PUyiuA+D1G3jmRGqn22ObX2D9zcKICQGA0DpFE2 k= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:content-transfer-encoding:content-type :date:from:in-reply-to:message-id:mime-version:references :subject:to:x-me-sender:x-me-sender:x-sasl-enc; s=fm1; bh=BLMa/p mdHlvtPuGEsIVD2KL4VBZBuQNZKQGFULJRhU0=; b=YWEo8yExheQTbk+gqSfqtg h1ezDCDJ54U97vbZIt1f4ffv0Dj5F7W1eWADyCWqLD2gXCDhg6eLMUKc9hJm6U0Y dem1A5XYZ1ToxwMj1OML2iQt88hys5+unCjzpH1qIGLwxodEY4Q+p6AmUoNmrglp aO8RVFiqucMuwvI/wdp7m3QBEXQO5qWRcUCSDdH4MR7cgTISZIJ63QSHwE+2wtck cwowZ7jKEW/EBZSr37tdWQkv16tiYfzSQ0VFeITzD/LJmTvYfOw/7UPMMg5KpzJz Z2iDHjLpPofWVESIvpPDlJDAgMKOIa6OuNS7hJz/uyxyQPp6092Y7Ar8CilQzxyg == X-ME-Sender: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 15C39240DE; Sun, 21 Jan 2018 15:15:17 -0500 (EST) From: Thomas Monjalon To: Neil Horman Cc: dev@dpdk.org, john.mcnamara@intel.com, bruce.richardson@intel.com Date: Sun, 21 Jan 2018 21:14:39 +0100 Message-ID: <3663302.jqOVGB4Z0T@xps> In-Reply-To: <20171213151728.16747-6-nhorman@tuxdriver.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-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" 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: Sun, 21 Jan 2018 20:15:18 -0000 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.