diff mbox

API version not dependent on test suite version

Message ID 1414680100-18689-1-git-send-email-petri.savolainen@linaro.org
State Accepted
Commit 4e5b733ffd520fcec3ec7e15d8c8d65255abef73
Headers show

Commit Message

Petri Savolainen Oct. 30, 2014, 2:41 p.m. UTC
Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
---

Notes:
    Test suite code is not part of the API spec. It's written
    against an API version. Test suite development and versioning runs
    in parallel to API versioning. E.g. test suite version 0.3.0-17 may
    be the latest test suite version for API version 0.3.0 and may have
    90% coverage. The next version (0.3.0-18) would improve coverage and
    fix bugs in tests, etc

 platform/linux-generic/include/api/odp_version.h | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)

Comments

Mike Holmes Oct. 30, 2014, 2:55 p.m. UTC | #1
On 30 October 2014 10:41, Petri Savolainen <petri.savolainen@linaro.org>
wrote:

> Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
> ---
>
> Notes:
>     Test suite code is not part of the API spec. It's written
>     against an API version. Test suite development and versioning runs
>     in parallel to API versioning. E.g. test suite version 0.3.0-17 may
>     be the latest test suite version for API version 0.3.0 and may have
>     90% coverage. The next version (0.3.0-18) would improve coverage and
>     fix bugs in tests, etc
>

Agreed, and for that reason the documentation spells this out in its
original form saying that the minor number does not reflect test changes,
the same is true for the linux-generic implementation.
The fact that both the linux-generic and the test code is in the same repo
as the API would be confusing without clarification as witnessed by weeks
of discussion on the topic.



>
>  platform/linux-generic/include/api/odp_version.h | 8 +++-----
>  1 file changed, 3 insertions(+), 5 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_version.h
> b/platform/linux-generic/include/api/odp_version.h
> index 0e5b8e0..4450452 100644
> --- a/platform/linux-generic/include/api/odp_version.h
> +++ b/platform/linux-generic/include/api/odp_version.h
> @@ -41,12 +41,10 @@ extern "C" {
>
>  /**
>   * ODP API minor version
> + *
>   * Minor version is incremented when introducing backward compatible
> changes
> - * to the API.
> - * For an API with common generation and major version, but with different
> - * minor numbers the two versions are backward compatible.
> - * Changes to the test suite will increment this digit.
> - * Changes to linux-generic will not increment this digit.
> + * to the API. For an API with common generation and major version, but
> with
> + * different minor numbers the two versions are backward compatible.
>   */
>  #define ODP_VERSION_API_MINOR 0
>
> --
> 2.1.1
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Savolainen, Petri (NSN - FI/Espoo) Nov. 6, 2014, 12:27 p.m. UTC | #2
Ping. We decided to break the dependency in the call yesterday.

-Petri

> -----Original Message-----
> From: ext Petri Savolainen [mailto:petri.savolainen@linaro.org]
> Sent: Thursday, October 30, 2014 4:42 PM
> To: lng-odp@lists.linaro.org
> Cc: Petri Savolainen
> Subject: [PATCH] API version not dependent on test suite version
> 
> Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
> ---
> 
> Notes:
>     Test suite code is not part of the API spec. It's written
>     against an API version. Test suite development and versioning runs
>     in parallel to API versioning. E.g. test suite version 0.3.0-17 may
>     be the latest test suite version for API version 0.3.0 and may have
>     90% coverage. The next version (0.3.0-18) would improve coverage and
>     fix bugs in tests, etc
> 
>  platform/linux-generic/include/api/odp_version.h | 8 +++-----
>  1 file changed, 3 insertions(+), 5 deletions(-)
> 
> diff --git a/platform/linux-generic/include/api/odp_version.h
> b/platform/linux-generic/include/api/odp_version.h
> index 0e5b8e0..4450452 100644
> --- a/platform/linux-generic/include/api/odp_version.h
> +++ b/platform/linux-generic/include/api/odp_version.h
> @@ -41,12 +41,10 @@ extern "C" {
> 
>  /**
>   * ODP API minor version
> + *
>   * Minor version is incremented when introducing backward compatible
> changes
> - * to the API.
> - * For an API with common generation and major version, but with
> different
> - * minor numbers the two versions are backward compatible.
> - * Changes to the test suite will increment this digit.
> - * Changes to linux-generic will not increment this digit.
> + * to the API. For an API with common generation and major version, but
> with
> + * different minor numbers the two versions are backward compatible.
>   */
>  #define ODP_VERSION_API_MINOR 0
> 
> --
> 2.1.1
Stuart Haslam Nov. 6, 2014, 3:14 p.m. UTC | #3
On Thu, Nov 06, 2014 at 12:27:02PM +0000, Savolainen, Petri (NSN - FI/Espoo) wrote:
> Ping. We decided to break the dependency in the call yesterday.
> 
> -Petri

I agree test suite versioning should be independent and there's no need
to specify what *isn't* covered by the version here as the _API_ naming
makes it clear it covers the API.

> 
> > -----Original Message-----
> > From: ext Petri Savolainen [mailto:petri.savolainen@linaro.org]
> > Sent: Thursday, October 30, 2014 4:42 PM
> > To: lng-odp@lists.linaro.org
> > Cc: Petri Savolainen
> > Subject: [PATCH] API version not dependent on test suite version
> > 
> > Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>

Reviewed-by: Stuart Haslam <stuart.haslam@arm.com>

> > ---
> > 
> > Notes:
> >     Test suite code is not part of the API spec. It's written
> >     against an API version. Test suite development and versioning runs
> >     in parallel to API versioning. E.g. test suite version 0.3.0-17 may
> >     be the latest test suite version for API version 0.3.0 and may have
> >     90% coverage. The next version (0.3.0-18) would improve coverage and
> >     fix bugs in tests, etc
> > 
> >  platform/linux-generic/include/api/odp_version.h | 8 +++-----
> >  1 file changed, 3 insertions(+), 5 deletions(-)
> > 
> > diff --git a/platform/linux-generic/include/api/odp_version.h
> > b/platform/linux-generic/include/api/odp_version.h
> > index 0e5b8e0..4450452 100644
> > --- a/platform/linux-generic/include/api/odp_version.h
> > +++ b/platform/linux-generic/include/api/odp_version.h
> > @@ -41,12 +41,10 @@ extern "C" {
> > 
> >  /**
> >   * ODP API minor version
> > + *
> >   * Minor version is incremented when introducing backward compatible
> > changes
> > - * to the API.
> > - * For an API with common generation and major version, but with
> > different
> > - * minor numbers the two versions are backward compatible.
> > - * Changes to the test suite will increment this digit.
> > - * Changes to linux-generic will not increment this digit.
> > + * to the API. For an API with common generation and major version, but
> > with
> > + * different minor numbers the two versions are backward compatible.
> >   */
> >  #define ODP_VERSION_API_MINOR 0
> > 
> > --
> > 2.1.1
>
Mike Holmes Nov. 6, 2014, 5:40 p.m. UTC | #4
Agree, will amend this and send a new revision
I will add an ODP API that can return a string that is the implementation
version as a second patch
A third patch to add a test suite version.


On 6 November 2014 10:14, Stuart Haslam <stuart.haslam@arm.com> wrote:

> On Thu, Nov 06, 2014 at 12:27:02PM +0000, Savolainen, Petri (NSN -
> FI/Espoo) wrote:
> > Ping. We decided to break the dependency in the call yesterday.
> >
> > -Petri
>
> I agree test suite versioning should be independent and there's no need
> to specify what *isn't* covered by the version here as the _API_ naming
> makes it clear it covers the API.
>
> >
> > > -----Original Message-----
> > > From: ext Petri Savolainen [mailto:petri.savolainen@linaro.org]
> > > Sent: Thursday, October 30, 2014 4:42 PM
> > > To: lng-odp@lists.linaro.org
> > > Cc: Petri Savolainen
> > > Subject: [PATCH] API version not dependent on test suite version
> > >
> > > Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
>
> Reviewed-by: Stuart Haslam <stuart.haslam@arm.com>
>
> > > ---
> > >
> > > Notes:
> > >     Test suite code is not part of the API spec. It's written
> > >     against an API version. Test suite development and versioning runs
> > >     in parallel to API versioning. E.g. test suite version 0.3.0-17 may
> > >     be the latest test suite version for API version 0.3.0 and may have
> > >     90% coverage. The next version (0.3.0-18) would improve coverage
> and
> > >     fix bugs in tests, etc
> > >
> > >  platform/linux-generic/include/api/odp_version.h | 8 +++-----
> > >  1 file changed, 3 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/platform/linux-generic/include/api/odp_version.h
> > > b/platform/linux-generic/include/api/odp_version.h
> > > index 0e5b8e0..4450452 100644
> > > --- a/platform/linux-generic/include/api/odp_version.h
> > > +++ b/platform/linux-generic/include/api/odp_version.h
> > > @@ -41,12 +41,10 @@ extern "C" {
> > >
> > >  /**
> > >   * ODP API minor version
> > > + *
> > >   * Minor version is incremented when introducing backward compatible
> > > changes
> > > - * to the API.
> > > - * For an API with common generation and major version, but with
> > > different
> > > - * minor numbers the two versions are backward compatible.
> > > - * Changes to the test suite will increment this digit.
> > > - * Changes to linux-generic will not increment this digit.
> > > + * to the API. For an API with common generation and major version,
> but
> > > with
> > > + * different minor numbers the two versions are backward compatible.
> > >   */
> > >  #define ODP_VERSION_API_MINOR 0
> > >
> > > --
> > > 2.1.1
> >
>
> --
> Stuart.
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Mike Holmes Nov. 6, 2014, 5:43 p.m. UTC | #5
On 6 November 2014 10:14, Stuart Haslam <stuart.haslam@arm.com> wrote:

> On Thu, Nov 06, 2014 at 12:27:02PM +0000, Savolainen, Petri (NSN -
> FI/Espoo) wrote:
> > Ping. We decided to break the dependency in the call yesterday.
> >
> > -Petri
>
> I agree test suite versioning should be independent and there's no need
> to specify what *isn't* covered by the version here as the _API_ naming
> makes it clear it covers the API.
>
> >
> > > -----Original Message-----
> > > From: ext Petri Savolainen [mailto:petri.savolainen@linaro.org]
> > > Sent: Thursday, October 30, 2014 4:42 PM
> > > To: lng-odp@lists.linaro.org
> > > Cc: Petri Savolainen
> > > Subject: [PATCH] API version not dependent on test suite version
> > >
> > > Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
>
> Reviewed-by: Stuart Haslam <stuart.haslam@arm.com>
>
Reviewed-by: Mike Holmes <mike.holmes@linaro.org>

>
> > > ---
> > >
> > > Notes:
> > >     Test suite code is not part of the API spec. It's written
> > >     against an API version. Test suite development and versioning runs
> > >     in parallel to API versioning. E.g. test suite version 0.3.0-17 may
> > >     be the latest test suite version for API version 0.3.0 and may have
> > >     90% coverage. The next version (0.3.0-18) would improve coverage
> and
> > >     fix bugs in tests, etc
> > >
> > >  platform/linux-generic/include/api/odp_version.h | 8 +++-----
> > >  1 file changed, 3 insertions(+), 5 deletions(-)
> > >
> > > diff --git a/platform/linux-generic/include/api/odp_version.h
> > > b/platform/linux-generic/include/api/odp_version.h
> > > index 0e5b8e0..4450452 100644
> > > --- a/platform/linux-generic/include/api/odp_version.h
> > > +++ b/platform/linux-generic/include/api/odp_version.h
> > > @@ -41,12 +41,10 @@ extern "C" {
> > >
> > >  /**
> > >   * ODP API minor version
> > > + *
> > >   * Minor version is incremented when introducing backward compatible
> > > changes
> > > - * to the API.
> > > - * For an API with common generation and major version, but with
> > > different
> > > - * minor numbers the two versions are backward compatible.
> > > - * Changes to the test suite will increment this digit.
> > > - * Changes to linux-generic will not increment this digit.
> > > + * to the API. For an API with common generation and major version,
> but
> > > with
> > > + * different minor numbers the two versions are backward compatible.
> > >   */
> > >  #define ODP_VERSION_API_MINOR 0
> > >
> > > --
> > > 2.1.1
> >
>
> --
> Stuart.
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
>
Maxim Uvarov Nov. 6, 2014, 6:41 p.m. UTC | #6
finally do not understand if it's ok or Mike, you are going to update it.

Maxim.

On 11/06/2014 08:43 PM, Mike Holmes wrote:
>
>
> On 6 November 2014 10:14, Stuart Haslam <stuart.haslam@arm.com 
> <mailto:stuart.haslam@arm.com>> wrote:
>
>     On Thu, Nov 06, 2014 at 12:27:02PM +0000, Savolainen, Petri (NSN -
>     FI/Espoo) wrote:
>     > Ping. We decided to break the dependency in the call yesterday.
>     >
>     > -Petri
>
>     I agree test suite versioning should be independent and there's no
>     need
>     to specify what *isn't* covered by the version here as the _API_
>     naming
>     makes it clear it covers the API.
>
>     >
>     > > -----Original Message-----
>     > > From: ext Petri Savolainen [mailto:petri.savolainen@linaro.org
>     <mailto:petri.savolainen@linaro.org>]
>     > > Sent: Thursday, October 30, 2014 4:42 PM
>     > > To: lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     > > Cc: Petri Savolainen
>     > > Subject: [PATCH] API version not dependent on test suite version
>     > >
>     > > Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org
>     <mailto:petri.savolainen@linaro.org>>
>
>     Reviewed-by: Stuart Haslam <stuart.haslam@arm.com
>     <mailto:stuart.haslam@arm.com>>
>
> Reviewed-by: Mike Holmes <mike.holmes@linaro.org 
> <mailto:mike.holmes@linaro.org>>
>
>
>     > > ---
>     > >
>     > > Notes:
>     > >     Test suite code is not part of the API spec. It's written
>     > >     against an API version. Test suite development and
>     versioning runs
>     > >     in parallel to API versioning. E.g. test suite version
>     0.3.0-17 may
>     > >     be the latest test suite version for API version 0.3.0 and
>     may have
>     > >     90% coverage. The next version (0.3.0-18) would improve
>     coverage and
>     > >     fix bugs in tests, etc
>     > >
>     > > platform/linux-generic/include/api/odp_version.h | 8 +++-----
>     > >  1 file changed, 3 insertions(+), 5 deletions(-)
>     > >
>     > > diff --git a/platform/linux-generic/include/api/odp_version.h
>     > > b/platform/linux-generic/include/api/odp_version.h
>     > > index 0e5b8e0..4450452 100644
>     > > --- a/platform/linux-generic/include/api/odp_version.h
>     > > +++ b/platform/linux-generic/include/api/odp_version.h
>     > > @@ -41,12 +41,10 @@ extern "C" {
>     > >
>     > >  /**
>     > >   * ODP API minor version
>     > > + *
>     > >   * Minor version is incremented when introducing backward
>     compatible
>     > > changes
>     > > - * to the API.
>     > > - * For an API with common generation and major version, but with
>     > > different
>     > > - * minor numbers the two versions are backward compatible.
>     > > - * Changes to the test suite will increment this digit.
>     > > - * Changes to linux-generic will not increment this digit.
>     > > + * to the API. For an API with common generation and major
>     version, but
>     > > with
>     > > + * different minor numbers the two versions are backward
>     compatible.
>     > >   */
>     > >  #define ODP_VERSION_API_MINOR 0
>     > >
>     > > --
>     > > 2.1.1
>     >
>
>     --
>     Stuart.
>
>
>     _______________________________________________
>     lng-odp mailing list
>     lng-odp@lists.linaro.org <mailto:lng-odp@lists.linaro.org>
>     http://lists.linaro.org/mailman/listinfo/lng-odp
>
>
>
>
> -- 
> *Mike Holmes*
> Linaro  Sr Technical Manager
> LNG - ODP
>
>
> _______________________________________________
> lng-odp mailing list
> lng-odp@lists.linaro.org
> http://lists.linaro.org/mailman/listinfo/lng-odp
Maxim Uvarov Nov. 6, 2014, 6:57 p.m. UTC | #7
Merged!

Maxim.

On 10/30/2014 05:41 PM, Petri Savolainen wrote:
> Signed-off-by: Petri Savolainen <petri.savolainen@linaro.org>
> ---
>
> Notes:
>      Test suite code is not part of the API spec. It's written
>      against an API version. Test suite development and versioning runs
>      in parallel to API versioning. E.g. test suite version 0.3.0-17 may
>      be the latest test suite version for API version 0.3.0 and may have
>      90% coverage. The next version (0.3.0-18) would improve coverage and
>      fix bugs in tests, etc
>
>   platform/linux-generic/include/api/odp_version.h | 8 +++-----
>   1 file changed, 3 insertions(+), 5 deletions(-)
>
> diff --git a/platform/linux-generic/include/api/odp_version.h b/platform/linux-generic/include/api/odp_version.h
> index 0e5b8e0..4450452 100644
> --- a/platform/linux-generic/include/api/odp_version.h
> +++ b/platform/linux-generic/include/api/odp_version.h
> @@ -41,12 +41,10 @@ extern "C" {
>   
>   /**
>    * ODP API minor version
> + *
>    * Minor version is incremented when introducing backward compatible changes
> - * to the API.
> - * For an API with common generation and major version, but with different
> - * minor numbers the two versions are backward compatible.
> - * Changes to the test suite will increment this digit.
> - * Changes to linux-generic will not increment this digit.
> + * to the API. For an API with common generation and major version, but with
> + * different minor numbers the two versions are backward compatible.
>    */
>   #define ODP_VERSION_API_MINOR 0
>
diff mbox

Patch

diff --git a/platform/linux-generic/include/api/odp_version.h b/platform/linux-generic/include/api/odp_version.h
index 0e5b8e0..4450452 100644
--- a/platform/linux-generic/include/api/odp_version.h
+++ b/platform/linux-generic/include/api/odp_version.h
@@ -41,12 +41,10 @@  extern "C" {
 
 /**
  * ODP API minor version
+ *
  * Minor version is incremented when introducing backward compatible changes
- * to the API.
- * For an API with common generation and major version, but with different
- * minor numbers the two versions are backward compatible.
- * Changes to the test suite will increment this digit.
- * Changes to linux-generic will not increment this digit.
+ * to the API. For an API with common generation and major version, but with
+ * different minor numbers the two versions are backward compatible.
  */
 #define ODP_VERSION_API_MINOR 0