version-spec.txt

   1
   2                         HOW TOR VERSION NUMBERS WORK
   3
   4 1. The Old Way
   5
   6  Before 0.1.0, versions were of the format:
   7      MAJOR.MINOR.MICRO(status(PATCHLEVEL))?(-cvs)?
   8  where MAJOR, MINOR, MICRO, and PATCHLEVEL are numbers, status is one
   9  of "pre" (for an alpha release), "rc" (for a release candidate), or
  10  "." for a release.  As a special case, "a.b.c" was equivalent to
  11  "a.b.c.0".  We compare the elements in order (major, minor, micro,
  12  status, patchlevel, cvs), with "cvs" preceding non-cvs.
  13
  14  We would start each development branch with a final version in mind:
  15  say, "0.0.8".  Our first pre-release would be "0.0.8pre1", followed by
  16  (for example) "0.0.8pre2-cvs", "0.0.8pre2", "0.0.8pre3-cvs",
  17  "0.0.8rc1", "0.0.8rc2-cvs", and "0.0.8rc2".  Finally, we'd release
  18  0.0.8.  The stable CVS branch would then be versioned "0.0.8.1-cvs",
  19  and any eventual bugfix release would be "0.0.8.1".
  20
  21 2. The New Way
  22
  23  After 0.1.0, versions are of the format:
  24     MAJOR.MINOR.MICRO[.PATCHLEVEL][-STATUS_TAG][ (EXTRA_INFO)]
  25  The stuff in parentheses is optional.  As before, MAJOR, MINOR, MICRO,
  26  and PATCHLEVEL are numbers, with an absent number equivalent to 0.
  27  All versions should be distinguishable purely by those four
  28  numbers.
  29
  30  The STATUS_TAG is purely informational, and lets you know how
  31  stable we think the release is: "alpha" is pretty unstable; "rc" is a
  32  release candidate; and no tag at all means that we have a final
  33  release. If the tag ends with "-cvs" or "-dev", you're looking at a
  34  development snapshot that came after a given release.  If we *do*
  35  encounter two versions that differ only by status tag, we compare them
  36  lexically as ASCII byte strings (ie, reverse-alphabetically so 'b' comes
  37  before 'a'). The STATUS_TAG can't contain whitespace.
  38
  39  The EXTRA_INFO is also purely informational, often containing information
  40  about the SCM commit this version came from. It is surrounded by parentheses
  41  and can't contain whitespace. Unlike the STATUS_TAG this never impacts the way
  42  that versions should be compared.
  43
  44  Now, we start each development branch with (say) 0.1.1.1-alpha.  The
  45  patchlevel increments consistently as the status tag changes, for
  46  example, as in: 0.1.1.2-alpha, 0.1.1.3-alpha, 0.1.1.4-rc, 0.1.1.5-rc.
  47  Eventually, we release 0.1.1.6.  The next patch release is 0.1.1.7.
  48
  49  Between these releases, CVS is versioned with a -cvs tag: after
  50  0.1.1.1-alpha comes 0.1.1.1-alpha-cvs, and so on. But starting with
  51  0.1.2.1-alpha-dev, we switched to SVN and started using the "-dev"
  52  suffix instead of the "-cvs" suffix.