summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2018-01-16 15:19:12 +0100
committerThomas Haller <thaller@redhat.com>2018-01-23 10:50:34 +0100
commitee742ab29e8892ce2424f020f836b7ed53da48a9 (patch)
tree5890b9eb650d447ffb73d3788f62ff5d66d55435 /docs
parent9c1684bec36e44f5a61f4cfd02f371447c99fcc2 (diff)
version: combine NM_VERSION_CUR_STABLE and NM_VERSION_NEXT_STABLE
We don't need to have two version defines "CUR" and "NEXT". The main purpose of these macros (if not their only), is to make NM_AVAILABLE_IN_* and NM_DEPRECATED_IN_* macros work. 1) At the precise commit of a release, "CUR" and "NEXT" must be identical, because whenever the user configures NM_VERSION_MIN_REQUIRED and NM_VERSION_MAX_ALLOWED, then they both compare against the current version, at which point "CUR" == "NEXT". 2) Every other commit aside the release, is a development version that leads up the the next coming release. But as far as versioning is concerned, such a development version should be treated like that future release. It's unstable API and it may or may not be close to later API of the release. But we shall treat it as that version. Hence, also in this case, we want to set both "NM_VERSION_CUR_STABLE" and again NEXT to the future version. This makes NM_VERSION_NEXT_STABLE redundant. Previously, the separation between current and next version would for example allow that NM_VERSION_CUR_STABLE is the previously release stable API, and NM_VERSION_NEXT_STABLE is the version of the next upcoming stable API. So, we could allow "examples" to make use of development API, but other(?) internal code still restrict to unstable API. But it's unclear which other code would want to avoid current development. Also, the points 1) and 2) were badly understood. Note that for our previousy releases, we usually didn't bump the macros at the stable release (and if we did, we didn't set them to be the same). While using two macros might be more powerful, it is hard to grok and easy to forget to bump the macros a the right time. One macro shall suffice. All this also means, that *immediately* after making a new release, we shall bump the version number in `configure.ac` and "NM_VERSION_CUR_STABLE".
Diffstat (limited to 'docs')
-rw-r--r--docs/libnm-glib/Makefile.am2
-rw-r--r--docs/libnm-util/Makefile.am2
-rw-r--r--docs/libnm/Makefile.am2
3 files changed, 3 insertions, 3 deletions
diff --git a/docs/libnm-glib/Makefile.am b/docs/libnm-glib/Makefile.am
index 5273148a9..e733f7650 100644
--- a/docs/libnm-glib/Makefile.am
+++ b/docs/libnm-glib/Makefile.am
@@ -56,7 +56,7 @@ GTKDOC_CFLAGS = \
-I$(top_builddir)/libnm-util \
-I$(top_srcdir)/libnm-glib \
-I$(top_builddir)/libnm-glib \
- -DNM_VERSION_MAX_ALLOWED=NM_VERSION_NEXT_STABLE \
+ -DNM_VERSION_MAX_ALLOWED=NM_VERSION_CUR_STABLE \
-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
$(GLIB_CFLAGS) \
$(DBUS_CFLAGS)
diff --git a/docs/libnm-util/Makefile.am b/docs/libnm-util/Makefile.am
index 75badb779..eb16d7601 100644
--- a/docs/libnm-util/Makefile.am
+++ b/docs/libnm-util/Makefile.am
@@ -50,7 +50,7 @@ extra_files =
# if $(DOC_MODULE).types is non-empty.
GTKDOC_CFLAGS = \
-I$(top_srcdir)/libnm-util \
- -DNM_VERSION_MAX_ALLOWED=NM_VERSION_NEXT_STABLE \
+ -DNM_VERSION_MAX_ALLOWED=NM_VERSION_CUR_STABLE \
-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
$(GLIB_CFLAGS) \
$(DBUS_CFLAGS)
diff --git a/docs/libnm/Makefile.am b/docs/libnm/Makefile.am
index 3ab55a8c4..362a43445 100644
--- a/docs/libnm/Makefile.am
+++ b/docs/libnm/Makefile.am
@@ -71,7 +71,7 @@ GTKDOC_CFLAGS = \
-I$(top_builddir)/libnm-core \
-I$(top_srcdir)/libnm \
-I$(top_builddir)/libnm \
- -DNM_VERSION_MAX_ALLOWED=NM_VERSION_NEXT_STABLE \
+ -DNM_VERSION_MAX_ALLOWED=NM_VERSION_CUR_STABLE \
-DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \
$(GLIB_CFLAGS)