Tweak docs for subversion release stuff to make better use of new

options.


git-svn-id: http://svn.python.org/projects/sandbox/trunk/setuptools@50538 6015fed2-1504-0410-9fe1-9d1591cc4771

1 files changed, 35 insertions, 16 deletions

diff --git a/setuptools.txt b/setuptools.txt
index 720064e..0348257 100755
--- a/setuptools.txt
+++ b/setuptools.txt
@@ -1523,22 +1523,6 @@ course possible for a single project to have both situations, using
 post-release numbering on release branches, and pre-release numbering on the
 trunk.  But you don't have to make things this complex if you don't want to.)
 
-When you make an official release, creating source or binary distributions,
-you will need to override the tag settings from ``setup.cfg``.  This is easy to
-do if you are developing on the trunk and using tags or branches for your
-releases - just make the change after branching or tagging the release, so the
-trunk will still produce development snapshots.
-
-Alternately, you can override the options on the command line, using
-something like::
-
-    python setup.py egg_info -RDb "" sdist bdist_egg register upload
-
-The first part of this command (``egg_info -RDb ""``) will override the
-configured tag information, before creating source and binary eggs, registering
-the project with PyPI, and uploading the files.  (See the section below on the
-`egg_info`_ command for more details on the command line options in use here.)
-
 Commonly, projects releasing code from Subversion will include a PyPI link to
 their checkout URL (as described in the previous section) with an
 ``#egg=projectname-dev`` suffix.  This allows users to request EasyInstall
@@ -1567,6 +1551,41 @@ from Subversion that they need to run ``setup.py develop`` after every update
 in order to keep their checkout completely in sync.
 
 
+Making "Official" (Non-Snapshot) Releases
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+When you make an official release, creating source or binary distributions,
+you will need to override the tag settings from ``setup.cfg``, so that you
+don't end up registering versions like ``foobar-0.7a1.dev-r34832``.  This is
+easy to do if you are developing on the trunk and using tags or branches for
+your releases - just make the change to ``setup.cfg`` after branching or
+tagging the release, so the trunk will still produce development snapshots.
+
+Alternately, if you are not branching for releases, you can override the
+default version options on the command line, using something like::
+
+    python setup.py egg_info -RDb "" sdist bdist_egg register upload
+
+The first part of this command (``egg_info -RDb ""``) will override the
+configured tag information, before creating source and binary eggs, registering
+the project with PyPI, and uploading the files.  Thus, these commands will use
+the plain version from your ``setup.py``, without adding the Subversion
+revision number or build designation string.
+
+Of course, if you will be doing this a lot, you may wish to create a personal
+alias for this operation, e.g.::
+
+    python setup.py alias -u release egg_info -RDb ""
+
+You can then use it like this::
+
+    python setup.py release sdist bdist_egg register upload
+
+Or of course you can create more elaborate aliases that do all of the above.
+See the sections below on the `egg_info`_ and `alias`_ commands for more ideas.
+
+
+
 Distributing Extensions compiled with Pyrex
 -------------------------------------------