Commit 3a467f69 authored by Jason R. Coombs's avatar Jason R. Coombs

Updated docs to match originally-intended behavior and the behavior of...

Updated docs to match originally-intended behavior and the behavior of setuptools 0.6. This fixes #278.

--HG--
branch : distribute
extra : rebase_source : 2b4f2ca890d32a2d1a3179bb1805b6a1f1e9be77
parent b5cd47fb
...@@ -6,6 +6,13 @@ CHANGES ...@@ -6,6 +6,13 @@ CHANGES
0.6.35 0.6.35
------ ------
Note this release is backward-incompatible with distribute 0.6.23-0.6.34 in
how it parses version numbers.
* Issue #278: Restored compatibility with distribute 0.6.22 and setuptools
0.6. Updated the documentation to match more closely with the version
parsing as intended in setuptools 0.6.
------ ------
0.6.34 0.6.34
------ ------
......
...@@ -187,10 +187,11 @@ than ``2.4.1`` (which has a higher release number). ...@@ -187,10 +187,11 @@ than ``2.4.1`` (which has a higher release number).
A pre-release tag is a series of letters that are alphabetically before A pre-release tag is a series of letters that are alphabetically before
"final". Some examples of prerelease tags would include ``alpha``, ``beta``, "final". Some examples of prerelease tags would include ``alpha``, ``beta``,
``a``, ``c``, ``dev``, and so on. You do not have to place a dot before ``a``, ``c``, ``dev``, and so on. You do not have to place a dot or dash
the prerelease tag if it's immediately after a number, but it's okay to do before the prerelease tag if it's immediately after a number, but it's okay to
so if you prefer. Thus, ``2.4c1`` and ``2.4.c1`` both represent release do so if you prefer. Thus, ``2.4c1`` and ``2.4.c1`` and ``2.4-c1`` all
candidate 1 of version ``2.4``, and are treated as identical by setuptools. represent release candidate 1 of version ``2.4``, and are treated as identical
by setuptools.
In addition, there are three special prerelease tags that are treated as if In addition, there are three special prerelease tags that are treated as if
they were the letter ``c``: ``pre``, ``preview``, and ``rc``. So, version they were the letter ``c``: ``pre``, ``preview``, and ``rc``. So, version
...@@ -216,13 +217,6 @@ a post-release tag, so this version is *newer* than ``0.6a9.dev``. ...@@ -216,13 +217,6 @@ a post-release tag, so this version is *newer* than ``0.6a9.dev``.
For the most part, setuptools' interpretation of version numbers is intuitive, For the most part, setuptools' interpretation of version numbers is intuitive,
but here are a few tips that will keep you out of trouble in the corner cases: but here are a few tips that will keep you out of trouble in the corner cases:
* Don't use ``-`` or any other character than ``.`` as a separator, unless you
really want a post-release. Remember that ``2.1-rc2`` means you've
*already* released ``2.1``, whereas ``2.1rc2`` and ``2.1.c2`` are candidates
you're putting out *before* ``2.1``. If you accidentally distribute copies
of a post-release that you meant to be a pre-release, the only safe fix is to
bump your main release number (e.g. to ``2.1.1``) and re-release the project.
* Don't stick adjoining pre-release tags together without a dot or number * Don't stick adjoining pre-release tags together without a dot or number
between them. Version ``1.9adev`` is the ``adev`` prerelease of ``1.9``, between them. Version ``1.9adev`` is the ``adev`` prerelease of ``1.9``,
*not* a development pre-release of ``1.9a``. Use ``.dev`` instead, as in *not* a development pre-release of ``1.9a``. Use ``.dev`` instead, as in
...@@ -239,7 +233,7 @@ but here are a few tips that will keep you out of trouble in the corner cases: ...@@ -239,7 +233,7 @@ but here are a few tips that will keep you out of trouble in the corner cases:
>>> parse_version('1.9.a.dev') == parse_version('1.9a0dev') >>> parse_version('1.9.a.dev') == parse_version('1.9a0dev')
True True
>>> parse_version('2.1-rc2') < parse_version('2.1') >>> parse_version('2.1-rc2') < parse_version('2.1')
False True
>>> parse_version('0.6a9dev-r41475') < parse_version('0.6a9') >>> parse_version('0.6a9dev-r41475') < parse_version('0.6a9')
True True
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment