On Tue, Dec 23, 2014 at 09:48:43AM +0000, Iremonger, Bernard wrote: > > -----Original Message----- > > From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Neil Horman > > Sent: Monday, December 22, 2014 8:24 PM > > To: dev at dpdk.org > > Subject: [dpdk-dev] [PATCH v2 4/4] docs: Add ABI documentation > > > > Adding a document describing rudimentary ABI policy and adding notice space > > for any deprecation > > announcements > > > > Signed-off-by: Neil Horman <nhorman at tuxdriver.com> > > CC: Thomas Monjalon <thomas.monjalon at 6wind.com> > > CC: "Richardson, Bruce" <bruce.richardson at intel.com> > > --- > > 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 > > Should this document be added to the guides documentation (for example > doc/guides/prog_guide)? > > Regards, > > Bernard. > > I don't think so, since this document is meant to be used not only by end users, but by other programmers while working on the dpdk.
Neil
