Attachment 57137 Details for Bug 46152 – Document Telepathy 1.0 versioning conventions

[patch] Document Telepathy 1.0 versioning conventions

0003-Document-Telepathy-1.0-versioning-conventions.patch (text/plain), 3.20 KB, created by Simon McVittie on 2012-02-16 02:32:03 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Simon McVittie

Created: 2012-02-16 02:32:03 UTC

Size: 3.20 KB

patch

obsolete

>From a067d3a0d2331de9050bf2ded2b1fbeaabf84a31 Mon Sep 17 00:00:00 2001
>From: Simon McVittie <simon.mcvittie@collabora.co.uk>
>Date: Thu, 16 Feb 2012 10:28:19 +0000
>Subject: [PATCH 3/3] Document Telepathy 1.0 versioning conventions
>
>---
> README |   35 ++++++++++++++++++++++-------------
> 1 files changed, 22 insertions(+), 13 deletions(-)
>
>diff --git a/README b/README
>index e99e967..f44a019 100644
>--- a/README
>+++ b/README
>@@ -28,18 +28,11 @@ Report all errata, feature requests and "to-do" items here:
> API stability policy
> ====================
> 
>-We use an "odd/even" versioning scheme where the minor version (the y in
>-x.y.z) determines stability - stable branches have y even, development
>-branches have y odd.
>+[Telepathy 1.0 has not yet been released, so this policy does not apply yet.]
> 
>-The following interfaces can change at any time, so please do not include them
>-in libraries:
>-
>-* interfaces whose names end with .DRAFT or .FUTURE
>-* interfaces with the tp:causes-havoc attribute
>-
>-Otherwise, we will not make the following changes in a stable branch, and we
>-avoid them where possible even in development branches:
>+The following changes are considered to be an API break, and will not be made
>+in released interfaces unless the interface's name is also changed, usually by
>+incrementing the version number at the end.
> 
> * Removing or renaming methods, signals or properties
> * Changing the D-Bus type signature of a method or signal's arguments
>@@ -47,10 +40,12 @@ avoid them where possible even in development branches:
>   of a property
> * Removing or renaming types (tp:struct etc.)
> * Changing the D-Bus type signature of a type (tp:struct etc.)
>+* Changing the name attribute of the <node> XML element
> 
> We do *not* consider the following changes to be an API break, and reserve the
>-right to make them at any time. Telepathy libraries/bindings should be done in
>-a way that will not break if we do these:
>+right to make them at any time, without changing the interface name.
>+Telepathy libraries/bindings should be done in a way that will not break
>+if we do these.
> 
> * Adding new methods or properties
> * Adding new signals, if that does not make old connection managers (that will
>@@ -67,6 +62,20 @@ a way that will not break if we do these:
> If any changes not mentioned here would break your library's API and you want
> us to avoid them, please ask for clarification on the mailing list.
> 
>+Core interfaces such as Channel, Connection and Account do not have a version
>+number at the end. Incompatible changes to these interfaces will only be made
>+in a new major version of telepathy-spec (which would rename all interfaces
>+by replacing im.telepathy1 with im.telepathy2 throughout).
>+
>+The "node name" (name attribute of the <node> XML element) reflects the name
>+and version of the interface, and the intended naming for generated code:
>+for instance, <node name="/Channel_Interface_Subject1"> can generate
>+functions, constants etc. whose names contain channel_interface_subject1,
>+ChannelInterfaceSubject1, channelInterfaceSubject1 or
>+CHANNEL_INTERFACE_SUBJECT1, as appropriate for the relevant language's naming
>+conventions. The "node name" should always correspond to the filename of the
>+XML.
>+
> Contact info
> ============
> 
>-- 
>1.7.9
>

Actions: View | Splinter Review

Attachments on bug 46152: 57135 | 57136 | 57137

Use of freedesktop.org services, including Bugzilla, is subject to our Code of Conduct. How we collect and use information is described in our Privacy Policy.