dev.dpdk.org archive mirror
 help / color / mirror / Atom feed
From: Neil Horman <nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
To: dev-VfR2kkLFssw@public.gmane.org
Subject: [PATCH 4/4] docs: Add ABI documentation
Date: Mon, 15 Sep 2014 15:23:51 -0400	[thread overview]
Message-ID: <1410809031-19114-5-git-send-email-nhorman@tuxdriver.com> (raw)
In-Reply-To: <1410809031-19114-1-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>

Adding a document describing rudimentary ABI policy and adding notice space for
any deprecation announcements

Signed-off-by: Neil Horman <nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
CC: Thomas Monjalon <thomas.monjalon-pdR9zngts4EAvxtiuMwx3w@public.gmane.org>
CC: "Richardson, Bruce" <bruce.richardson-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
---
 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

  parent reply	other threads:[~2014-09-15 19:23 UTC|newest]

Thread overview: 43+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-09-15 19:23 [PATCH 0/4] Add DSO symbol versioning to support backwards compatibility Neil Horman
     [not found] ` <1410809031-19114-1-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-09-15 19:23   ` [PATCH 1/4] compat: Add infrastructure to support symbol versioning Neil Horman
     [not found]     ` <1410809031-19114-2-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-09-23 10:39       ` Sergio Gonzalez Monroy
     [not found]         ` <20140923103923.GA4642-IWE99D/oH1/+pXziaqXtF9h3ngVCH38I@public.gmane.org>
2014-09-23 14:58           ` Neil Horman
     [not found]             ` <20140923145829.GB12884-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-09-23 16:29               ` Sergio Gonzalez Monroy
     [not found]                 ` <20140923162947.GA22463-IWE99D/oH1/+pXziaqXtF9h3ngVCH38I@public.gmane.org>
2014-09-23 17:31                   ` Neil Horman
2014-09-25 18:52       ` [PATCH 1/4 v2] " Neil Horman
     [not found]         ` <1411671152-27245-1-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-09-26 14:16           ` Sergio Gonzalez Monroy
     [not found]             ` <20140926141608.GA10993-IWE99D/oH1/+pXziaqXtF9h3ngVCH38I@public.gmane.org>
2014-09-26 15:16               ` Neil Horman
     [not found]                 ` <20140926151630.GD5619-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-09-26 15:33                   ` Sergio Gonzalez Monroy
     [not found]                     ` <20140926153304.GA16923-IWE99D/oH1/+pXziaqXtF9h3ngVCH38I@public.gmane.org>
2014-09-26 16:22                       ` Neil Horman
     [not found]                         ` <20140926162256.GF5619-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-09-26 19:19                           ` Neil Horman
2014-09-29 15:44       ` [PATCH 1/4 v3] " Neil Horman
     [not found]         ` <1412005443-20000-1-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-09-30  8:13           ` Sergio Gonzalez Monroy
2014-09-30 15:18       ` [PATCH 1/4 v4] " Neil Horman
     [not found]         ` <1412090280-9306-1-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-10-01 10:15           ` Sergio Gonzalez Monroy
     [not found]             ` <20141001101530.GA28292-IWE99D/oH1/+pXziaqXtF9h3ngVCH38I@public.gmane.org>
2014-10-01 10:38               ` Neil Horman
2014-10-01 11:28           ` Sergio Gonzalez Monroy
2014-09-15 19:23   ` [PATCH 2/4] Provide initial versioning for all DPDK libraries Neil Horman
     [not found]     ` <1410809031-19114-3-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-09-19  9:45       ` Bruce Richardson
2014-09-19 10:22         ` Neil Horman
2014-10-01 11:25       ` Sergio Gonzalez Monroy
     [not found]         ` <20141001112546.GA17019-IWE99D/oH1/+pXziaqXtF9h3ngVCH38I@public.gmane.org>
2014-10-01 14:43           ` Neil Horman
2014-09-15 19:23   ` [PATCH 3/4] Add library version extenstion Neil Horman
     [not found]     ` <1410809031-19114-4-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-10-01 11:27       ` Sergio Gonzalez Monroy
2014-09-15 19:23   ` Neil Horman [this message]
     [not found]     ` <1410809031-19114-5-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-10-01 16:06       ` [PATCH 4/4] docs: Add ABI documentation Sergio Gonzalez Monroy
2014-09-18 18:23   ` [PATCH 0/4] Add DSO symbol versioning to support backwards compatibility Thomas Monjalon
2014-09-18 19:14     ` Neil Horman
     [not found]       ` <20140918191401.GP20389-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-09-19  8:57         ` Richardson, Bruce
2014-09-19 14:18         ` Venkatesan, Venky
     [not found]           ` <541C3B3C.9070105-ral2JQCrhuEAvxtiuMwx3w@public.gmane.org>
2014-09-19 17:45             ` Neil Horman
2014-09-24 18:19         ` Neil Horman
     [not found]           ` <20140924181940.GB4651-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-09-26 10:41             ` Thomas Monjalon
2014-09-26 14:45               ` Neil Horman
     [not found]                 ` <20140926144549.GA5619-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-09-26 22:02                   ` Stephen Hemminger
2014-09-27  2:22                     ` Neil Horman
2014-10-01 18:59                   ` Neil Horman
     [not found]                     ` <20141001185940.GA27437-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-10-07 21:01                       ` Neil Horman
     [not found]                         ` <20141007210135.GH27719-B26myB8xz7F8NnZeBjwnZQMhkBWG/bsMQH7oEaQurus@public.gmane.org>
2014-10-08 15:57                           ` Thomas Monjalon
2014-10-08 18:46                             ` Butler, Siobhan A
2014-10-08 19:09                             ` Neil Horman
  -- strict thread matches above, loose matches on Subject: below --
2014-12-20 21:01 Add DSO symbol versioning to supportbackwards compatibility Neil Horman
     [not found] ` <1419109299-9603-1-git-send-email-nhorman-2XuSBdqkA4R54TAoqtyWWQ@public.gmane.org>
2014-12-20 21:01   ` [PATCH 4/4] docs: Add ABI documentation Neil Horman

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1410809031-19114-5-git-send-email-nhorman@tuxdriver.com \
    --to=nhorman-2xusbdqka4r54taoqtywwq@public.gmane.org \
    --cc=dev-VfR2kkLFssw@public.gmane.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).