From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 634CCA00BE; Tue, 7 Jul 2020 19:00:47 +0200 (CEST) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id D28E11D426; Tue, 7 Jul 2020 19:00:46 +0200 (CEST) Received: from new1-smtp.messagingengine.com (new1-smtp.messagingengine.com [66.111.4.221]) by dpdk.org (Postfix) with ESMTP id 8E72A4F9A for ; Tue, 7 Jul 2020 19:00:45 +0200 (CEST) Received: from compute7.internal (compute7.nyi.internal [10.202.2.47]) by mailnew.nyi.internal (Postfix) with ESMTP id 34B4358045F; Tue, 7 Jul 2020 13:00:44 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute7.internal (MEProxy); Tue, 07 Jul 2020 13:00:44 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding:content-type; s=fm1; bh= RYHAdUwxCao7E343KC9pvEovA9n9sGgHGGee3aZmX6Y=; b=QmnkHxijwlK01QFD +nKi3FChYqODW1mg4ew9RftL1oZcbwiDDMai3FBBiYSS5W+D5Z1cjtf791SWZk61 UFt9C8Yn98/uvIJLifWXMkKE5UJM0ymLGgsFgWWMNSByyJb+vO0lWwZ8itqaykLu miqtXI8YHNkzBMmpkbGCzaqN6EEKl8XcDva3G+oYTwN3esbJAOHt7Y4PMmxEgzYj xJtsG+Pg1S0Yza6iQCG/zxV0x4ffyPKl2fbWRdtahlItSWCZT5fgDZ+VGPQgiO9G IlLgK6OvohxyTL2pSLBDh1h2fun4P5am8ZV04aDcPmFRdD+IXuZXHWCLx6ICl91P kOtOKA== 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-proxy:x-me-proxy:x-me-sender:x-me-sender :x-sasl-enc; s=fm3; bh=RYHAdUwxCao7E343KC9pvEovA9n9sGgHGGee3aZmX 6Y=; b=IuzxKBnB6qcrRyfmmXeSHRW4ujpMNIgV/Si+Gg59G5PG49dgWG91AESW9 PYecsmnuqv9ufce2GyNBdfIGy4cT849WumrLWTgqjcWRo6v3kExa1l20S9wGD7Y8 XUSp03HtwIMczTsFvVrVXoF97AP5UAVQcNiSMBN6q3QmOJqbp2CzCHhkC7l1mV+q asD5+itS9ocyH5Igw5Y+nnDIktLEnVlzSrCWw0tHY8VGaSPik4fhneNAaaQ3CdOe ul1YjTuQE489IGej76MSf/QJHgb4MsiAup8IB+0snjLyJ5ozjKwSuhOK1/kC4L/N TiFGKq3II9uIS7bQMoGnChJNMUJLQ== X-ME-Sender: X-ME-Proxy-Cause: gggruggvucftvghtrhhoucdtuddrgeduiedrudehgddutddvucetufdoteggodetrfdotf fvucfrrhhofhhilhgvmecuhfgrshhtofgrihhlpdfqfgfvpdfurfetoffkrfgpnffqhgen uceurghilhhouhhtmecufedttdenucesvcftvggtihhpihgvnhhtshculddquddttddmne cujfgurhephffvufffkfgjfhgggfgtsehtufertddttddvnecuhfhrohhmpefvhhhomhgr shcuofhonhhjrghlohhnuceothhhohhmrghssehmohhnjhgrlhhonhdrnhgvtheqnecugg ftrfgrthhtvghrnhepudeggfdvfeduffdtfeeglefghfeukefgfffhueejtdetuedtjeeu ieeivdffgeehnecukfhppeejjedrudefgedrvddtfedrudekgeenucevlhhushhtvghruf hiiigvpedtnecurfgrrhgrmhepmhgrihhlfhhrohhmpehthhhomhgrshesmhhonhhjrghl ohhnrdhnvght X-ME-Proxy: Received: from xps.localnet (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id 7A08A328006A; Tue, 7 Jul 2020 13:00:42 -0400 (EDT) From: Thomas Monjalon To: "Kinsella, Ray" , Honnappa Nagarahalli Cc: "dev@dpdk.org" , "fady@mellanox.com" , Neil Horman , John McNamara , Marko Kovacevic , Harini Ramakrishnan , Omar Cardona , Pallavi Kadam , Ranjit Menon , "david.marchand@redhat.com" , "bruce.richardson@intel.com" , nd Date: Tue, 07 Jul 2020 19:00:41 +0200 Message-ID: <1615812.mBlSNTTGHt@thomas> In-Reply-To: References: <1594133126-2518-1-git-send-email-mdr@ashroe.eu> <97d6e4fb-4fd3-e161-7b95-8ff3d505f2e7@ashroe.eu> MIME-Version: 1.0 Content-Transfer-Encoding: 7Bit Content-Type: text/plain; charset="us-ascii" Subject: Re: [dpdk-dev] [PATCH v1 2/2] doc: clarify alias to experimental period 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" 07/07/2020 18:55, Honnappa Nagarahalli: > > On 07/07/2020 17:36, Thomas Monjalon wrote: > > > 07/07/2020 18:35, Kinsella, Ray: > > >> On 07/07/2020 16:26, Thomas Monjalon wrote: > > >>> 07/07/2020 16:45, Ray Kinsella: > > >>>> Clarify retention period for aliases to experimental. > > >>>> > > >>>> Signed-off-by: Ray Kinsella > > >>>> --- > > >>>> --- a/doc/guides/contributing/abi_versioning.rst > > >>>> +++ b/doc/guides/contributing/abi_versioning.rst > > >>>> @@ -158,7 +158,7 @@ The macros exported are: > > >>>> * ``VERSION_SYMBOL_EXPERIMENTAL(b, e)``: Creates a symbol version > > table entry > > >>>> binding versioned symbol ``b@EXPERIMENTAL`` to the internal > > function ``be``. > > >>>> The macro is used when a symbol matures to become part of the > > >>>> stable ABI, to > > >>>> - provide an alias to experimental for some time. > > >>>> + provide an alias to experimental until the next major ABI version. > > >>> > > >>> Why limiting the period for experimental status? > > >>> Some API want to remain experimental longer. > > This is not limiting the period. > This is about how long VERSION_SYMBOL_EXPERIMENTAL should be in place > for a symbol after the experimental tag is removed for the symbol. Oh wait, I was wrong. It is only about the alias which is set AFTER the experimental period. > > >>> [...] > > >>>> In situations in which an ``experimental`` symbol has been stable > > >>>> for some time, and it becomes a candidate for promotion to the > > >>>> stable ABI. At this time, when -promoting the symbol, maintainer > > >>>> may choose to provide an alias to the -``experimental`` symbol version, > > so as not to break consuming applications. > > >>>> +promoting the symbol, the maintainer may choose to provide an > > >>>> +alias to the ``experimental`` symbol version, so as not to break > > >>>> +consuming applications. This > > >>> > > >>> Please start a sentence on a new line. > > >> > > >> ACK > > >> > > >>> > > >>>> +alias will then typically be dropped in the next major ABI version. > > >>> > > >>> I don't see the need for the time estimation. > > I prefer this wording as it clarifying what should be done while creating a patch. Yes, after a second read, I am OK.