Revert "all: change "Since: 1.2" to "Since: 1.0.4"/"Since: 1.0.6" for backported API"

API should be added with "Since:" of the next release on the same branch.
That means, new API on 1.1 branch (development), should be "Since: 1.2"
and new API on 1.0 branch (stable) will be "Since: 1.0.x". Similarly, new
API on master is NM_AVAILABLE_IN_1_2 and will be added with the linker
version libnl_1_2 -- never the versions of minor releases.

It is also strongly advised that for the 1.0 branch, we only add API
that was previously formerly added on master. IOW, that we only do true
backports of API that already exists on master.

API that gets backported, must also be added to master via NM_BACKPORT_SYMBOL().
That gives ABI compatibility and an application that was build against 1.0.x
will work with 1.y.z version (y > 0) without need for recompiling -- provided
that 1.y.z also contains that API.

There is one important caveat: if a major branch (e.g. current master) has a
linker section of backported APIs (e.g. libnm_1_0_6), we must do the minor release
(1.0.6) before the next major release (1.2). The reason is that after the major
release, the linker section (libnm_1_0_6) must not be extended and thus
the minor release (1.0.6) must be already released at that point.

In general, users should avoid using backported API because it limits
the ability to upgrade to arbitrary later versions. But together with the
previous point (that we only backport API to minor releases), a user that
uses backported API can be sure that a 1.y.z version is ABI compatible with
1.0.x, if the 1.y.z release date was after the release date of 1.0.x.

This reverts commit 02a136682c.
This commit is contained in:
Thomas Haller 2015-08-22 00:57:30 +02:00
parent 913f5d9898
commit b2a66d59c8
5 changed files with 8 additions and 8 deletions

View file

@ -616,7 +616,7 @@ nm_setting_connection_is_slave_type (NMSettingConnection *setting,
* Returns: whether slaves of the connection should be activated together
* with the connection.
*
* Since: 1.0.4
* Since: 1.2
**/
NMSettingConnectionAutoconnectSlaves
nm_setting_connection_get_autoconnect_slaves (NMSettingConnection *setting)
@ -771,7 +771,7 @@ nm_setting_connection_get_gateway_ping_timeout (NMSettingConnection *setting)
*
* Returns: the #NMSettingConnection:metered property of the setting.
*
* Since: 1.0.6
* Since: 1.2
**/
NMMetered
nm_setting_connection_get_metered (NMSettingConnection *setting)

View file

@ -2873,7 +2873,7 @@ _wifi_freqs (gboolean bg_band)
*
* Returns: zero-terminated array of frequencies numbers (in MHz)
*
* Since: 1.0.6
* Since: 1.2
**/
const guint *
nm_utils_wifi_2ghz_freqs (void)
@ -2889,7 +2889,7 @@ NM_BACKPORT_SYMBOL (libnm_1_0_6, const guint *, nm_utils_wifi_2ghz_freqs, (void)
*
* Returns: zero-terminated array of frequencies numbers (in MHz)
*
* Since: 1.0.6
* Since: 1.2
**/
const guint *
nm_utils_wifi_5ghz_freqs (void)

View file

@ -232,7 +232,7 @@ nm_access_point_get_strength (NMAccessPoint *ap)
*
* Returns: the last seen time in seconds
*
* Since: 1.0.6
* Since: 1.2
**/
gint
nm_access_point_get_last_seen (NMAccessPoint *ap)

View file

@ -355,7 +355,7 @@ nm_device_wifi_request_scan (NMDeviceWifi *device,
* Returns: %TRUE on success, %FALSE on error, in which case @error will be
* set.
*
* Since: 1.0.6
* Since: 1.2
**/
gboolean
nm_device_wifi_request_scan_options (NMDeviceWifi *device,
@ -467,7 +467,7 @@ nm_device_wifi_request_scan_async (NMDeviceWifi *device,
* D-Bus call. Valid otions inside the dictionary are:
* 'ssids' => array of SSIDs (saay)
*
* Since: 1.0.6
* Since: 1.2
**/
void
nm_device_wifi_request_scan_options_async (NMDeviceWifi *device,

View file

@ -1969,7 +1969,7 @@ nm_device_get_mtu (NMDevice *device)
*
* Returns: the metered setting.
*
* Since: 1.0.6
* Since: 1.2
**/
NMMetered
nm_device_get_metered (NMDevice *device)