diff mbox

[v3] odp_version.h: Update version number

Message ID 1414425898-4301-1-git-send-email-mike.holmes@linaro.org
State Accepted
Commit a25acf5f8565a14ead91946ef573d4558cf41c2d
Headers show

Commit Message

Mike Holmes Oct. 27, 2014, 4:04 p.m. UTC
Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
---
 configure.ac                                     |  2 +-
 platform/linux-generic/include/api/odp_version.h | 39 ++++++++++++------------
 2 files changed, 20 insertions(+), 21 deletions(-)

Comments

Bill Fischofer Oct. 27, 2014, 4:14 p.m. UTC | #1
>
>
>  /**
> - * ODP API bug correction version
> - *
> - * Bug corrections to the API files. APIs with the same major and sub
> - * versions, but different bug correction versions are backward
> compatible.
> + * 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.
>   */
>

If changes to linux-generic will not change this digit, how will they be
tracked?
Maxim Uvarov Oct. 27, 2014, 4:23 p.m. UTC | #2
Merged and tagged.

Maxim.

On 10/27/2014 07:04 PM, Mike Holmes wrote:
> Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> ---
>   configure.ac                                     |  2 +-
>   platform/linux-generic/include/api/odp_version.h | 39 ++++++++++++------------
>   2 files changed, 20 insertions(+), 21 deletions(-)
>
> diff --git a/configure.ac b/configure.ac
> index aa94034..456c5fa 100644
> --- a/configure.ac
> +++ b/configure.ac
> @@ -1,5 +1,5 @@
>   AC_PREREQ([2.5])
> -AC_INIT([OpenDataPlane], [0.2], [lng-odp@lists.linaro.org])
> +AC_INIT([OpenDataPlane], [0.3.0], [lng-odp@lists.linaro.org])
>   AM_INIT_AUTOMAKE([subdir-objects])
>   AC_CONFIG_SRCDIR([helper/config.h.in])
>   AM_CONFIG_HEADER([helper/config.h])
> diff --git a/platform/linux-generic/include/api/odp_version.h b/platform/linux-generic/include/api/odp_version.h
> index 3a75201..0e5b8e0 100644
> --- a/platform/linux-generic/include/api/odp_version.h
> +++ b/platform/linux-generic/include/api/odp_version.h
> @@ -23,30 +23,32 @@ extern "C" {
>    */
>   
>   /**
> - * ODP API main version
> + * ODP API generation version
>    *
> - * Introduction of major new features or changes. APIs with different major
> + * Introduction of major new features or changes that make
> + * very significant changes to the API. APIs with different
>    * versions are likely not backward compatible.
>    */
> -#define ODP_VERSION_API_MAIN  0
> +#define ODP_VERSION_API_GENERATION 0
>   
>   /**
> - * ODP API sub version
> + * ODP API major version
>    *
> - * Introduction of additional features or minor changes. APIs with common
> - * major version and different sub versions may be backward compatible (if only
> - * additions).
> + * Introduction of major new features or changes. APIs with different major
> + * versions are likely not backward compatible.
>    */
> -#define ODP_VERSION_API_SUB   0
> +#define ODP_VERSION_API_MAJOR 3
>   
>   /**
> - * ODP API bug correction version
> - *
> - * Bug corrections to the API files. APIs with the same major and sub
> - * versions, but different bug correction versions are backward compatible.
> + * 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.
>    */
> -#define ODP_VERSION_API_BUG   1
> -
> +#define ODP_VERSION_API_MINOR 0
>   
>   /** @internal Version string expand */
>   #define ODP_VERSION_STR_EXPAND(x)  #x
> @@ -56,10 +58,9 @@ extern "C" {
>   
>   /** @internal API version string */
>   #define ODP_VERSION_API_STR \
> -ODP_VERSION_TO_STR(ODP_VERSION_API_MAIN) "."\
> -ODP_VERSION_TO_STR(ODP_VERSION_API_SUB) "."\
> -ODP_VERSION_TO_STR(ODP_VERSION_API_BUG)
> -
> +ODP_VERSION_TO_STR(ODP_VERSION_API_GENERATION) "."\
> +ODP_VERSION_TO_STR(ODP_VERSION_API_MAJOR) "."\
> +ODP_VERSION_TO_STR(ODP_VERSION_API_MINOR)
>   
>   /**
>    * Returns ODP API version string
> @@ -69,8 +70,6 @@ static inline const char *odp_version_api_str(void)
>   	return ODP_VERSION_API_STR;
>   }
>   
> -
> -
>   /**
>    * @}
>    */
Savolainen, Petri (NSN - FI/Espoo) Oct. 28, 2014, 9:19 a.m. UTC | #3
> -----Original Message-----
> From: lng-odp-bounces@lists.linaro.org [mailto:lng-odp-
> bounces@lists.linaro.org] On Behalf Of ext Maxim Uvarov
> Sent: Monday, October 27, 2014 6:24 PM
> To: lng-odp@lists.linaro.org
> Subject: Re: [lng-odp] [PATCH v3] odp_version.h: Update version number
> 
> Merged and tagged.
> 
> Maxim.
> 
> On 10/27/2014 07:04 PM, Mike Holmes wrote:
> > Signed-off-by: Mike Holmes <mike.holmes@linaro.org>
> > ---
> >   configure.ac                                     |  2 +-
> >   platform/linux-generic/include/api/odp_version.h | 39 ++++++++++++----
> --------
> >   2 files changed, 20 insertions(+), 21 deletions(-)
> >
> > diff --git a/configure.ac b/configure.ac
> > index aa94034..456c5fa 100644
> > --- a/configure.ac
> > +++ b/configure.ac
> > @@ -1,5 +1,5 @@
> >   AC_PREREQ([2.5])
> > -AC_INIT([OpenDataPlane], [0.2], [lng-odp@lists.linaro.org])
> > +AC_INIT([OpenDataPlane], [0.3.0], [lng-odp@lists.linaro.org])
> >   AM_INIT_AUTOMAKE([subdir-objects])
> >   AC_CONFIG_SRCDIR([helper/config.h.in])
> >   AM_CONFIG_HEADER([helper/config.h])
> > diff --git a/platform/linux-generic/include/api/odp_version.h
> b/platform/linux-generic/include/api/odp_version.h
> > index 3a75201..0e5b8e0 100644
> > --- a/platform/linux-generic/include/api/odp_version.h
> > +++ b/platform/linux-generic/include/api/odp_version.h
> > @@ -23,30 +23,32 @@ extern "C" {
> >    */
> >
> >   /**
> > - * ODP API main version
> > + * ODP API generation version
> >    *
> > - * Introduction of major new features or changes. APIs with different
> major
> > + * Introduction of major new features or changes that make
> > + * very significant changes to the API. APIs with different
> >    * versions are likely not backward compatible.
> >    */
> > -#define ODP_VERSION_API_MAIN  0
> > +#define ODP_VERSION_API_GENERATION 0
> >
> >   /**
> > - * ODP API sub version
> > + * ODP API major version
> >    *
> > - * Introduction of additional features or minor changes. APIs with
> common
> > - * major version and different sub versions may be backward compatible
> (if only
> > - * additions).
> > + * Introduction of major new features or changes. APIs with different
> major
> > + * versions are likely not backward compatible.
> >    */
> > -#define ODP_VERSION_API_SUB   0
> > +#define ODP_VERSION_API_MAJOR 3
> >
> >   /**
> > - * ODP API bug correction version
> > - *
> > - * Bug corrections to the API files. APIs with the same major and sub
> > - * versions, but different bug correction versions are backward
> compatible.
> > + * 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.


Test suite is not part of the API. It's written against an API version. Maybe each and every API version does not have a 100% matching test suite provided from Linaro. That's OK as long as all important/long term API releases have a matching test suite. Don't tie test suite development into API version numbering. The comment should be removed.


> > + * Changes to linux-generic will not increment this digit.

This is true, but can be removed also. Changes to any implementation will not roll API version number.


-Petri
diff mbox

Patch

diff --git a/configure.ac b/configure.ac
index aa94034..456c5fa 100644
--- a/configure.ac
+++ b/configure.ac
@@ -1,5 +1,5 @@ 
 AC_PREREQ([2.5])
-AC_INIT([OpenDataPlane], [0.2], [lng-odp@lists.linaro.org])
+AC_INIT([OpenDataPlane], [0.3.0], [lng-odp@lists.linaro.org])
 AM_INIT_AUTOMAKE([subdir-objects])
 AC_CONFIG_SRCDIR([helper/config.h.in])
 AM_CONFIG_HEADER([helper/config.h])
diff --git a/platform/linux-generic/include/api/odp_version.h b/platform/linux-generic/include/api/odp_version.h
index 3a75201..0e5b8e0 100644
--- a/platform/linux-generic/include/api/odp_version.h
+++ b/platform/linux-generic/include/api/odp_version.h
@@ -23,30 +23,32 @@  extern "C" {
  */
 
 /**
- * ODP API main version
+ * ODP API generation version
  *
- * Introduction of major new features or changes. APIs with different major
+ * Introduction of major new features or changes that make
+ * very significant changes to the API. APIs with different
  * versions are likely not backward compatible.
  */
-#define ODP_VERSION_API_MAIN  0
+#define ODP_VERSION_API_GENERATION 0
 
 /**
- * ODP API sub version
+ * ODP API major version
  *
- * Introduction of additional features or minor changes. APIs with common
- * major version and different sub versions may be backward compatible (if only
- * additions).
+ * Introduction of major new features or changes. APIs with different major
+ * versions are likely not backward compatible.
  */
-#define ODP_VERSION_API_SUB   0
+#define ODP_VERSION_API_MAJOR 3
 
 /**
- * ODP API bug correction version
- *
- * Bug corrections to the API files. APIs with the same major and sub
- * versions, but different bug correction versions are backward compatible.
+ * 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.
  */
-#define ODP_VERSION_API_BUG   1
-
+#define ODP_VERSION_API_MINOR 0
 
 /** @internal Version string expand */
 #define ODP_VERSION_STR_EXPAND(x)  #x
@@ -56,10 +58,9 @@  extern "C" {
 
 /** @internal API version string */
 #define ODP_VERSION_API_STR \
-ODP_VERSION_TO_STR(ODP_VERSION_API_MAIN) "."\
-ODP_VERSION_TO_STR(ODP_VERSION_API_SUB) "."\
-ODP_VERSION_TO_STR(ODP_VERSION_API_BUG)
-
+ODP_VERSION_TO_STR(ODP_VERSION_API_GENERATION) "."\
+ODP_VERSION_TO_STR(ODP_VERSION_API_MAJOR) "."\
+ODP_VERSION_TO_STR(ODP_VERSION_API_MINOR)
 
 /**
  * Returns ODP API version string
@@ -69,8 +70,6 @@  static inline const char *odp_version_api_str(void)
 	return ODP_VERSION_API_STR;
 }
 
-
-
 /**
  * @}
  */