| Message ID | 1411745003-4448-1-git-send-email-mike.holmes@linaro.org |
|---|---|
| State | Rejected |
| Headers | show |
Sorry forgot "ARCH PATCHv2" On 26 September 2014 11:23, Mike Holmes <mike.holmes@linaro.org> wrote: > Signed-off-by: Mike Holmes <mike.holmes@linaro.org> > Reviewed-by: Anders Roxell <anders.roxell@linaro.org> > --- > > V2: > Add a note to the Majori section to highlight that although the API is now > bacwards incompatible, the change may be inconsequential to a given > applicaion. > Fix copyright date. > > release.dox | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ > 1 file changed, 48 insertions(+) > create mode 100644 release.dox > > diff --git a/release.dox b/release.dox > new file mode 100644 > index 0000000..7caa662 > --- /dev/null > +++ b/release.dox > @@ -0,0 +1,48 @@ > +/* Copyright (c) 2014, Linaro Limited > + * All rights reserved > + * > + * SPDX-License-Identifier: BSD-3-Clause > + */ > + > +/** > +@page release Release Management > +@tableofcontents > +@section release_numbering Numbering > + > +The API uses a three digit release number, for ODP this number refers to > +- The API header definitions > +- The refreence implementation (linux-generic) > +- The documentation > +- The API test & validation suit that certifies the headers and > documentation. > + > +The ODP API major.minor version will only change at well-defined release > points. > +A release will be tagged ODP-<major>.<minor> and bug fix releases on the > platform will be tagged ODP-<major>.<minor>.<sub> first bug fix release sub > = 1. > + > +@subsection major Major > +The major digit is the ODP API generation. > +A change to this digit will break backwards compatibility. > +@note The incompatibilty covers the whole ODP API, however the change may > be a tiny change to an esoteric function that is not used by a given > applicaion. > + > +- Altering API signature > +- Altering a structure > +- Changing the required calling sequence for APIs > +- Changes to the installed structure > +- New element to an enum that is an output from ODP > + > +@subsection minor Minor > +The minor digit is for changes that are backwards compatible. > +For example changes such as the addition of a new API. > +Existing application code shall not have to change if the new API is not > used. > +- Adding a new struct > +- Adding a new function > +- Adding an additional alternate API to an existing one. > +- New element to an enum that is an input to ODP > + > +@subsection sub Sub > +The sub digit is used for backward compatible changes > +Any existing app should work as before with the caveat that a bug fix may > change the executable behavior (hopefully improve it) > +- Optimize the implementation > +- Documentation updates > +- bug fixes in implementation > + > +*/ > -- > 1.9.1 > >
Spell check s/applicacion/spplication/ On Friday, September 26, 2014, Mike Holmes <mike.holmes@linaro.org> wrote: > Sorry forgot "ARCH PATCHv2" > > On 26 September 2014 11:23, Mike Holmes <mike.holmes@linaro.org > <javascript:_e(%7B%7D,'cvml','mike.holmes@linaro.org');>> wrote: > >> Signed-off-by: Mike Holmes <mike.holmes@linaro.org >> <javascript:_e(%7B%7D,'cvml','mike.holmes@linaro.org');>> >> Reviewed-by: Anders Roxell <anders.roxell@linaro.org >> <javascript:_e(%7B%7D,'cvml','anders.roxell@linaro.org');>> >> --- >> >> V2: >> Add a note to the Majori section to highlight that although the API is >> now bacwards incompatible, the change may be inconsequential to a given >> applicaion. >> Fix copyright date. >> >> release.dox | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ >> 1 file changed, 48 insertions(+) >> create mode 100644 release.dox >> >> diff --git a/release.dox b/release.dox >> new file mode 100644 >> index 0000000..7caa662 >> --- /dev/null >> +++ b/release.dox >> @@ -0,0 +1,48 @@ >> +/* Copyright (c) 2014, Linaro Limited >> + * All rights reserved >> + * >> + * SPDX-License-Identifier: BSD-3-Clause >> + */ >> + >> +/** >> +@page release Release Management >> +@tableofcontents >> +@section release_numbering Numbering >> + >> +The API uses a three digit release number, for ODP this number refers to >> +- The API header definitions >> +- The refreence implementation (linux-generic) >> +- The documentation >> +- The API test & validation suit that certifies the headers and >> documentation. >> + >> +The ODP API major.minor version will only change at well-defined release >> points. >> +A release will be tagged ODP-<major>.<minor> and bug fix releases on the >> platform will be tagged ODP-<major>.<minor>.<sub> first bug fix release sub >> = 1. >> + >> +@subsection major Major >> +The major digit is the ODP API generation. >> +A change to this digit will break backwards compatibility. >> +@note The incompatibilty covers the whole ODP API, however the change >> may be a tiny change to an esoteric function that is not used by a given >> applicaion. >> + >> +- Altering API signature >> +- Altering a structure >> +- Changing the required calling sequence for APIs >> +- Changes to the installed structure >> +- New element to an enum that is an output from ODP >> + >> +@subsection minor Minor >> +The minor digit is for changes that are backwards compatible. >> +For example changes such as the addition of a new API. >> +Existing application code shall not have to change if the new API is not >> used. >> +- Adding a new struct >> +- Adding a new function >> +- Adding an additional alternate API to an existing one. >> +- New element to an enum that is an input to ODP >> + >> +@subsection sub Sub >> +The sub digit is used for backward compatible changes >> +Any existing app should work as before with the caveat that a bug fix >> may change the executable behavior (hopefully improve it) >> +- Optimize the implementation >> +- Documentation updates >> +- bug fixes in implementation >> + >> +*/ >> -- >> 1.9.1 >> >> > > > -- > *Mike Holmes* > Linaro Technical Manager / Lead > LNG - ODP >
darn it On 26 September 2014 11:50, Bill Fischofer <bill.fischofer@linaro.org> wrote: > Spell check > s/applicacion/spplication/ > > > On Friday, September 26, 2014, Mike Holmes <mike.holmes@linaro.org> wrote: > >> Sorry forgot "ARCH PATCHv2" >> >> On 26 September 2014 11:23, Mike Holmes <mike.holmes@linaro.org> wrote: >> >>> Signed-off-by: Mike Holmes <mike.holmes@linaro.org> >>> Reviewed-by: Anders Roxell <anders.roxell@linaro.org> >>> --- >>> >>> V2: >>> Add a note to the Majori section to highlight that although the API is >>> now bacwards incompatible, the change may be inconsequential to a given >>> applicaion. >>> Fix copyright date. >>> >>> release.dox | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ >>> 1 file changed, 48 insertions(+) >>> create mode 100644 release.dox >>> >>> diff --git a/release.dox b/release.dox >>> new file mode 100644 >>> index 0000000..7caa662 >>> --- /dev/null >>> +++ b/release.dox >>> @@ -0,0 +1,48 @@ >>> +/* Copyright (c) 2014, Linaro Limited >>> + * All rights reserved >>> + * >>> + * SPDX-License-Identifier: BSD-3-Clause >>> + */ >>> + >>> +/** >>> +@page release Release Management >>> +@tableofcontents >>> +@section release_numbering Numbering >>> + >>> +The API uses a three digit release number, for ODP this number refers to >>> +- The API header definitions >>> +- The refreence implementation (linux-generic) >>> +- The documentation >>> +- The API test & validation suit that certifies the headers and >>> documentation. >>> + >>> +The ODP API major.minor version will only change at well-defined >>> release points. >>> +A release will be tagged ODP-<major>.<minor> and bug fix releases on >>> the platform will be tagged ODP-<major>.<minor>.<sub> first bug fix release >>> sub = 1. >>> + >>> +@subsection major Major >>> +The major digit is the ODP API generation. >>> +A change to this digit will break backwards compatibility. >>> +@note The incompatibilty covers the whole ODP API, however the change >>> may be a tiny change to an esoteric function that is not used by a given >>> applicaion. >>> + >>> +- Altering API signature >>> +- Altering a structure >>> +- Changing the required calling sequence for APIs >>> +- Changes to the installed structure >>> +- New element to an enum that is an output from ODP >>> + >>> +@subsection minor Minor >>> +The minor digit is for changes that are backwards compatible. >>> +For example changes such as the addition of a new API. >>> +Existing application code shall not have to change if the new API is >>> not used. >>> +- Adding a new struct >>> +- Adding a new function >>> +- Adding an additional alternate API to an existing one. >>> +- New element to an enum that is an input to ODP >>> + >>> +@subsection sub Sub >>> +The sub digit is used for backward compatible changes >>> +Any existing app should work as before with the caveat that a bug fix >>> may change the executable behavior (hopefully improve it) >>> +- Optimize the implementation >>> +- Documentation updates >>> +- bug fixes in implementation >>> + >>> +*/ >>> -- >>> 1.9.1 >>> >>> >> >> >> -- >> *Mike Holmes* >> Linaro Technical Manager / Lead >> LNG - ODP >> >
diff --git a/release.dox b/release.dox new file mode 100644 index 0000000..7caa662 --- /dev/null +++ b/release.dox @@ -0,0 +1,48 @@ +/* Copyright (c) 2014, Linaro Limited + * All rights reserved + * + * SPDX-License-Identifier: BSD-3-Clause + */ + +/** +@page release Release Management +@tableofcontents +@section release_numbering Numbering + +The API uses a three digit release number, for ODP this number refers to +- The API header definitions +- The refreence implementation (linux-generic) +- The documentation +- The API test & validation suit that certifies the headers and documentation. + +The ODP API major.minor version will only change at well-defined release points. +A release will be tagged ODP-<major>.<minor> and bug fix releases on the platform will be tagged ODP-<major>.<minor>.<sub> first bug fix release sub = 1. + +@subsection major Major +The major digit is the ODP API generation. +A change to this digit will break backwards compatibility. +@note The incompatibilty covers the whole ODP API, however the change may be a tiny change to an esoteric function that is not used by a given applicaion. + +- Altering API signature +- Altering a structure +- Changing the required calling sequence for APIs +- Changes to the installed structure +- New element to an enum that is an output from ODP + +@subsection minor Minor +The minor digit is for changes that are backwards compatible. +For example changes such as the addition of a new API. +Existing application code shall not have to change if the new API is not used. +- Adding a new struct +- Adding a new function +- Adding an additional alternate API to an existing one. +- New element to an enum that is an input to ODP + +@subsection sub Sub +The sub digit is used for backward compatible changes +Any existing app should work as before with the caveat that a bug fix may change the executable behavior (hopefully improve it) +- Optimize the implementation +- Documentation updates +- bug fixes in implementation + +*/