From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga14.intel.com (mga14.intel.com [192.55.52.115]) by dpdk.org (Postfix) with ESMTP id B07F9106A for ; Wed, 1 Oct 2014 17:59:33 +0200 (CEST) Received: from fmsmga003.fm.intel.com ([10.253.24.29]) by fmsmga103.fm.intel.com with ESMTP; 01 Oct 2014 08:56:52 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="4.97,862,1389772800"; d="scan'208";a="394181463" Received: from irvmail001.ir.intel.com ([163.33.26.43]) by FMSMGA003.fm.intel.com with ESMTP; 01 Oct 2014 08:59:55 -0700 Received: from sivswdev02.ir.intel.com (sivswdev02.ir.intel.com [10.237.217.46]) by irvmail001.ir.intel.com (8.14.3/8.13.6/MailSET/Hub) with ESMTP id s91G6GCG001377; Wed, 1 Oct 2014 17:06:16 +0100 Received: from sivswdev02.ir.intel.com (localhost [127.0.0.1]) by sivswdev02.ir.intel.com with ESMTP id s91G6GpF025442; Wed, 1 Oct 2014 17:06:16 +0100 Received: (from smonroy@localhost) by sivswdev02.ir.intel.com with id s91G6Fhx025438; Wed, 1 Oct 2014 17:06:15 +0100 Date: Wed, 1 Oct 2014 17:06:15 +0100 From: Sergio Gonzalez Monroy To: Neil Horman Message-ID: <20141001160610.GA25008@sivswdev02.ir.intel.com> References: <1410809031-19114-1-git-send-email-nhorman@tuxdriver.com> <1410809031-19114-5-git-send-email-nhorman@tuxdriver.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <1410809031-19114-5-git-send-email-nhorman@tuxdriver.com> User-Agent: Mutt/1.5.20 (2009-06-14) Cc: dev@dpdk.org Subject: Re: [dpdk-dev] [PATCH 4/4] docs: Add ABI documentation X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Wed, 01 Oct 2014 15:59:34 -0000 Acked-by: Sergio Gonzalez Monroy On Mon, Sep 15, 2014 at 03:23:51PM -0400, Neil Horman wrote: > Adding a document describing rudimentary ABI policy and adding notice space for > any deprecation announcements > > Signed-off-by: Neil Horman > CC: Thomas Monjalon > CC: "Richardson, Bruce" > --- > doc/abi.txt | 17 +++++++++++++++++ > 1 file changed, 17 insertions(+) > create mode 100644 doc/abi.txt > > diff --git a/doc/abi.txt b/doc/abi.txt > new file mode 100644 > index 0000000..b6dcc7d > --- /dev/null > +++ b/doc/abi.txt > @@ -0,0 +1,17 @@ > +ABI policy: > + ABI versions are set at the time of major release labeling, and ABI may > +change multiple times between the last labeling and the HEAD label of the git > +tree without warning > + > + ABI versions, once released are available until such time as their > +deprecation has been noted here for at least one major release cycle, after it > +has been tagged. E.g. the ABI for DPDK 1.8 is shipped, and then the decision to > +remove it is made during the development of DPDK 1.9. The decision will be > +recorded here, shipped with the DPDK 1.9 release, and actually removed when DPDK > +1.10 ships. > + > + ABI versions may be deprecated in whole, or in part as needed by a given > +update. > + > +Deprecation Notices: > + > -- > 1.9.3 >