From mboxrd@z Thu Jan  1 00:00:00 1970
From: Thomas Monjalon <thomas@monjalon.net>
Subject: Re: [PATCH 3/3] lib/librte_meter: update abi to include
	new rfc4115 function
Date: Wed, 28 Nov 2018 13:51:39 +0100
Message-ID: <34321981.0ZahcR99rh@xps>
References: <154333204294.44971.12989297399338053044.stgit@dbuild>
 <3306361.jWiN20gDd9@xps> <F5B98C79-06B0-45C8-8440-82019AF1391C@redhat.com>
Mime-Version: 1.0
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7Bit
Cc: dev@dpdk.org, David Marchand <david.marchand@redhat.com>,
 cristian.dumitrescu@intel.com
To: Eelco Chaudron <echaudro@redhat.com>
Return-path: <dev-bounces@dpdk.org>
Received: from wout2-smtp.messagingengine.com (wout2-smtp.messagingengine.com
 [64.147.123.25]) by dpdk.org (Postfix) with ESMTP id 808C91B3A9
 for <dev@dpdk.org>; Wed, 28 Nov 2018 13:51:43 +0100 (CET)
In-Reply-To: <F5B98C79-06B0-45C8-8440-82019AF1391C@redhat.com>
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

28/11/2018 13:40, Eelco Chaudron:
> 
> On 28 Nov 2018, at 11:09, Thomas Monjalon wrote:
> 
> > 28/11/2018 10:27, Eelco Chaudron:
> >> On 28 Nov 2018, at 9:38, David Marchand wrote:
> >>> On Tue, Nov 27, 2018 at 4:22 PM Eelco Chaudron <echaudro@redhat.com>
> >>> wrote:
> >>>> --- a/lib/librte_meter/Makefile
> >>>> +++ b/lib/librte_meter/Makefile
> >>>> -LIBABIVER := 2
> >>>> +LIBABIVER := 3
> >>>
> >>> As far as I understood the policy around the EXPERIMENTAL section, 
> >>> you
> >>> don't need to bump the library version.
> >>
> >> Thought I would add the new function as none experimental, i.e. next
> >> version, but checkpatch did not allow me to do this.
> >>
> >> Tried to find info on what the right process was, as these functions 
> >> are
> >> just another meter implementation using similar existing APIs. If 
> >> anyone
> >> has any background on this please point me to it.
> >
> > It is documented here:
> > 	http://doc.dpdk.org/guides/contributing/versioning.html
> >
> > The case for "similar API" is not handled specifically so far.
> > So you need to introduce it as experimental.
> 
> Thanks for the clarification, will update the APIs with 
> __rte_experimental in the next iteration.

You should also add this on top of the doxygen comment:

 * @warning
 * @b EXPERIMENTAL: this API may change without prior notice