summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-06-15 18:00:27 +0900
committerAtomic Bot <atomic-devel@projectatomic.io>2017-06-15 12:59:59 +0000
commit3e3a0f0766918e4750d136bcb2782482135d0b49 (patch)
treedca332904be5bce6f7650400870b5adbae2c7695
parent9529e8d43579aaf6f6ebb90516385a89aaff34ff (diff)
downloadostree-3e3a0f0766918e4750d136bcb2782482135d0b49.tar.gz
ostreee-version.h.in: Added Since: version annotations
This is especially interesting for the versioning symbols themselves, as it is an indicator of when applications using introspection information can start to use a symbol in the library to check if they have a recent enough version of OSTree to use. Closes: #932 Approved by: cgwalters
-rw-r--r--src/libostree/ostree-version.h.in12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/libostree/ostree-version.h.in b/src/libostree/ostree-version.h.in
index 7d775cc2..3f4d0fb7 100644
--- a/src/libostree/ostree-version.h.in
+++ b/src/libostree/ostree-version.h.in
@@ -32,6 +32,8 @@
* OSTREE_YEAR_VERSION:
*
* ostree year version component (e.g. 2017 if %OSTREE_VERSION is 2017.2)
+ *
+ * Since: 2017.4
*/
#define OSTREE_YEAR_VERSION (@YEAR_VERSION@)
@@ -39,6 +41,8 @@
* OSTREE_RELEASE_VERSION:
*
* ostree release version component (e.g. 2 if %OSTREE_VERSION is 2017.2)
+ *
+ * Since: 2017.4
*/
#define OSTREE_RELEASE_VERSION (@RELEASE_VERSION@)
@@ -46,6 +50,8 @@
* OSTREE_VERSION
*
* ostree version.
+ *
+ * Since: 2017.4
*/
#define OSTREE_VERSION (@VERSION@)
@@ -54,6 +60,8 @@
*
* ostree version, encoded as a string, useful for printing and
* concatenation.
+ *
+ * Since: 2017.4
*/
#define OSTREE_VERSION_S "@VERSION@"
@@ -65,6 +73,8 @@
*
* ostree version, encoded as an hexadecimal number, useful for
* integer comparisons.
+ *
+ * Since: 2017.4
*/
#define OSTREE_VERSION_HEX \
(OSTREE_ENCODE_VERSION (OSTREE_YEAR_VERSION, OSTREE_RELEASE_VERSION))
@@ -76,6 +86,8 @@
*
* Compile-time version checking. Evaluates to %TRUE if the version
* of ostree is equal or greater than the required one.
+ *
+ * Since: 2017.4
*/
#define OSTREE_CHECK_VERSION(year,release) \
(OSTREE_YEAR_VERSION > (year) || \