1. Brian Mearns
  2. tome

Commits

Brian Mearns  committed 1a74817

Added partial draft of compat.txt to describe version numbering and compatibility.

  • Participants
  • Parent commits 533c2a5
  • Branches default

Comments (0)

Files changed (2)

File doc/compat.txt

View file
  • Ignore whitespace
+
+              The Tome Version Numbering and Compatibility Plan
+
+
+Tome uses a 4 part version number, with each part corresponding to a
+particular class of changes, and in general correspond to a specific level of
+compatibility.
+
+The 4 part version is of the form: <Major>.<minor>.<patch>.<semantic>, or more
+succinctly: "M.n.p.s".
+
+The Major version ("M") is the most significant component: a change to the
+Major version number generally represents a major change to the program,
+but more specifically it indicates a *complete* loss of compatibility. In
+other words, a Major version change will remove an existing interface.
+Software that interfaces with a particular version of tome will not (in
+general) work with a different Major version of tome.
+
+The minor version ("n") is next most significant, after Major. A change to the
+minor version number specifically indicates an addition to the interface, and
+a loss of *forwards* compatibility, but preservation of *backwards*
+compatibility. Software that interfaces with a particular version of tome will
+not work with versions that have an earlier minor version, but will work if
+the major version is the same, and the minor version is greater or equal.
+
+The patch version ("p") is the least significant version that actually changes
+the code. A change to the patch version preserves both backwards *and*
+forwards compatibility, so the interface is perfectly preserved. This can
+cover any number of things, from bug fixes, to optimizations, even added
+capabilities that don't effect the interface.
+
+Lastly, the semantic version ("s") refers to changes to the package that don't
+actually effect the code. This might be added documentation or comments in the
+code, or something similar. You aren't likely to see changes to the semantic
+version very often, because they usually don't justify a new release.
+
+**What makes up the interface?
+
+**How to read the CHANGES file?
+
+
+
+
+
+
+
+# vim: set tw=78:
+

File src/tome/version.py

View file
  • Ignore whitespace
 MINOR       = 1
 PATCH       = 0
 SEMANTIC    = 0
+RELEASE     = 2
 
 YEAR        = 2013
 MONTH       = 1