diff options
Diffstat (limited to 'helper/include/odp/helper/version.h.in')
-rw-r--r-- | helper/include/odp/helper/version.h.in | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/helper/include/odp/helper/version.h.in b/helper/include/odp/helper/version.h.in new file mode 100644 index 000000000..e576de561 --- /dev/null +++ b/helper/include/odp/helper/version.h.in @@ -0,0 +1,72 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright (c) 2019 Nokia + */ + + +/** + * @file + * + * ODP helper version + */ + +#ifndef ODPH_VERSION_H_ +#define ODPH_VERSION_H_ + +#ifdef __cplusplus +extern "C" { +#endif + +/** + * @defgroup odph_version ODPH VERSION + * Helper library version + * + * @{ + */ + +/** + * ODP helper generation version + * + * Introduction of major new features or changes that make very significant + * changes to the helper library. + */ +#define ODPH_VERSION_GENERATION @ODPH_VERSION_GENERATION@ + +/** + * ODP helper major version + * + * Introduction of major new features or changes. Helper libraries with common + * generation, but with different major version numbers are likely not backward + * compatible. + */ +#define ODPH_VERSION_MAJOR @ODPH_VERSION_MAJOR@ + +/** + * ODP helper minor version + * + * Minor version is incremented when introducing backward compatible changes. + * Helper libraries with common generation and major version, but with + * different minor version numbers are backward compatible. + */ +#define ODPH_VERSION_MINOR @ODPH_VERSION_MINOR@ + +/** + * ODP helper version string + * + * The version string defines the helper library version in this format: + * @verbatim <generation>.<major>.<minor> @endverbatim + * + * The string is null terminated. + * + * @return Pointer to helper library version string + */ +const char *odph_version_str(void); + +/** + * @} + */ + +#ifdef __cplusplus +} +#endif + +#endif |