[doc] owlps: add Cross-version compatibility note

This commit is contained in:
Matteo Cypriani 2013-06-23 14:18:43 -04:00 committed by Matteo Cypriani
parent 763b36807e
commit 779c859add
1 changed files with 13 additions and 2 deletions

View File

@ -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.