From 779c859adda303c1f073e0fe66a4225ac3574661 Mon Sep 17 00:00:00 2001 From: Matteo Cypriani Date: Sun, 23 Jun 2013 14:18:43 -0400 Subject: [PATCH] [doc] owlps: add Cross-version compatibility note --- doc/owlps.t2t | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/doc/owlps.t2t b/doc/owlps.t2t index 8d97de3..8e22ab6 100644 --- a/doc/owlps.t2t +++ b/doc/owlps.t2t @@ -98,7 +98,7 @@ revision number. Development point release are numbered with an odd minor version number and a mandatory revision number starting at 0, for example: - v0.9.0 -- v1.1.0 +- v1.1.2 - v1.3.3 @@ -107,7 +107,18 @@ revision number is not mandatory, but it is allowed. For example: - v0.8 - v1.0 - v1.2 -- v1.2.1 (this one does not exist for real!) +- v1.2.1 (this one doesn't exist for real!) + + +++ Cross-version compatibility ++ + +The communication protocol between the elements of the system is +guaranteed to stay the same across revisions of a given stable branch +(e.g. mixing modules of versions 1.2, 1.2.1 and 1.2.2 is possible). In +development branches, the protocol can evolve from one point release to +the next (e.g. mixing modules of versions 1.3.0 and 1.3.1 is not +possible). Changes in communication protocols, libraries' APIs, file +formats, etc., are pointed out in the ``CHANGELOG`` file.