From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <bernard.iremonger@intel.com>
Received: from mga09.intel.com (mga09.intel.com [134.134.136.24])
 by dpdk.org (Postfix) with ESMTP id 380119603
 for <dev@dpdk.org>; Tue, 23 Dec 2014 10:48:49 +0100 (CET)
Received: from fmsmga001.fm.intel.com ([10.253.24.23])
 by orsmga102.jf.intel.com with ESMTP; 23 Dec 2014 01:46:54 -0800
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.07,630,1413270000"; d="scan'208";a="641843791"
Received: from irsmsx102.ger.corp.intel.com ([163.33.3.155])
 by fmsmga001.fm.intel.com with ESMTP; 23 Dec 2014 01:48:45 -0800
Received: from irsmsx108.ger.corp.intel.com ([169.254.11.71]) by
 IRSMSX102.ger.corp.intel.com ([169.254.2.213]) with mapi id 14.03.0195.001;
 Tue, 23 Dec 2014 09:48:44 +0000
From: "Iremonger, Bernard" <bernard.iremonger@intel.com>
To: Neil Horman <nhorman@tuxdriver.com>, "dev@dpdk.org" <dev@dpdk.org>
Thread-Topic: [dpdk-dev] [PATCH v2 4/4] docs: Add ABI documentation
Thread-Index: AQHQHiVqt01tXuPc60mgKSA91RnU8Zyc7ieA
Date: Tue, 23 Dec 2014 09:48:43 +0000
Message-ID: <8CEF83825BEC744B83065625E567D7C2049CBDB3@IRSMSX108.ger.corp.intel.com>
References: <1419109299-9603-1-git-send-email-nhorman@tuxdriver.com>
 <1419279860-16985-1-git-send-email-nhorman@tuxdriver.com>
 <1419279860-16985-4-git-send-email-nhorman@tuxdriver.com>
In-Reply-To: <1419279860-16985-4-git-send-email-nhorman@tuxdriver.com>
Accept-Language: en-GB, en-US
Content-Language: en-US
X-MS-Has-Attach: 
X-MS-TNEF-Correlator: 
x-originating-ip: [163.33.239.182]
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
Subject: Re: [dpdk-dev] [PATCH v2 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 <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
X-List-Received-Date: Tue, 23 Dec 2014 09:48:49 -0000

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Neil Horman
> Sent: Monday, December 22, 2014 8:24 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] [PATCH v2 4/4] docs: Add ABI documentation
>=20
> Adding a document describing rudimentary ABI policy and adding notice spa=
ce for any deprecation
> announcements
>=20
> Signed-off-by: Neil Horman <nhorman@tuxdriver.com>
> CC: Thomas Monjalon <thomas.monjalon@6wind.com>
> CC: "Richardson, Bruce" <bruce.richardson@intel.com>
> ---
>  doc/abi.txt | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
>  create mode 100644 doc/abi.txt
>=20
> 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

Should this document be added to the guides documentation (for example doc/=
guides/prog_guide)?

Regards,

Bernard.