From 851c5b46d98ce2443d97b55a42de86290686130b Mon Sep 17 00:00:00 2001 From: "phillip.eby" Date: Thu, 21 Aug 2008 17:20:42 +0000 Subject: Misc. documentation updates/fixes git-svn-id: http://svn.python.org/projects/sandbox/trunk/setuptools@65934 6015fed2-1504-0410-9fe1-9d1591cc4771 --- EasyInstall.txt | 65 +++++++++++++++++++++----------------------------------- README.txt | 8 +++---- pkg_resources.py | 5 +++-- wikiup.cfg | 5 +++++ 4 files changed, 36 insertions(+), 47 deletions(-) create mode 100755 wikiup.cfg diff --git a/EasyInstall.txt b/EasyInstall.txt index e250192..3a8a4a2 100755 --- a/EasyInstall.txt +++ b/EasyInstall.txt @@ -30,47 +30,30 @@ Using "Easy Install" Installing "Easy Install" ------------------------- -Download `ez_setup.py `_, and -run it; this will download and install the appropriate ``setuptools`` egg for -your Python version. (You will need at least Python 2.3.5, or if you are on a -64-bit platform, Python 2.4.) An ``easy_install`` script will be installed in -the normal location for Python scripts on your platform. (Windows users, don't -put ``ez_setup.py`` inside your Python installation; please put it in some -other directory before running it.) - -You may receive a message telling you about an obsolete version of setuptools -being present; if so, you must be sure to delete it entirely, along with the -old ``pkg_resources`` module if it's present on ``sys.path``. - -The ``ez_setup.py`` script accepts the same `Command-Line Options`_ and -`Configuration Files`_ as ``easy_install`` itself, so you can use them to -control its behavior. In particular, you can use the --script-dir option to -direct script installation to a custom location. You should not, however, -use custom installation locations without first reading the section below on -`Custom Installation Locations`_. - -The instructions you've just read assume that: - -* You are installling to Python's primary ``site-packages`` directory - -* You have unrestricted internet access on the computer where you are - installing. - -If you are behind an NTLM-based firewall that prevents Python programs from -accessing the net directly, you may wish to first install and use the `APS -proxy server `_, which lets you get past such firewalls -in the same way that your web browser(s) do. This will let ``ez_setup.py`` -download the setuptools egg. - -If you can't use APS, or don't have internet access at all, you will need to -first download the appropriate ``.egg`` file from the `setuptools PyPI page -`_ using a computer with internet -access. Place the egg in the same directory as ``ez_setup.py`` on the target -computer before running it. - -If you are installing to a custom location or do not have write access to -Python's primary ``site-packages`` directory, please also see the section below -on `Custom Installation Locations`_ for more detailed instructions. +Please see the `setuptools PyPI page `_ +for download links and basic installation instructions for each of the +supported platforms. + +You will need at least Python 2.3.5, or if you are on a 64-bit platform, Python +2.4. An ``easy_install`` script will be installed in the normal location for +Python scripts on your platform. + +Note that the instructions on the setuptools PyPI page assume that you are +are installling to Python's primary ``site-packages`` directory. If this is +not the case, you should consult the section below on `Custom Installation +Locations`_ before installing. (And, on Windows, you should not use the +``.exe`` installer when installing to an alternate location.) + +Note that ``easy_install`` normally works by downloading files from the +internet. If you are behind an NTLM-based firewall that prevents Python +programs from accessing the net directly, you may wish to first install and use +the `APS proxy server `_, which lets you get past such +firewalls in the same way that your web browser(s) do. + +(Alternately, if you do not wish easy_install to actually download anything, you +can restrict it from doing so with the ``--allow-hosts`` option; see the +sections on `restricting downloads with --allow-hosts`_ and `command-line +options`_ for more details.) Troubleshooting diff --git a/README.txt b/README.txt index 528c573..896aaa2 100755 --- a/README.txt +++ b/README.txt @@ -45,9 +45,9 @@ Cygwin, Mac OS X, Linux, Other ============================== 1. Download the appropriate egg for your version of Python (e.g. - ``setuptools-0.6c4-py2.4.egg``). Do NOT rename it. + ``setuptools-0.6c9-py2.4.egg``). Do NOT rename it. -2. Run it as if it were a shell script, e.g. ``sh setuptools-0.6c4-py2.4.egg``. +2. Run it as if it were a shell script, e.g. ``sh setuptools-0.6c9-py2.4.egg``. Setuptools will install itself using the matching version of Python (e.g. ``python2.4``), and will place the ``easy_install`` executable in the default location for installing Python scripts (as determined by the @@ -59,7 +59,7 @@ may include EasyInstall command-line options such as ``--prefix``, ``--install-dir``, and so on, following the ``.egg`` filename on the same command line. For example:: - sh setuptools-0.6c4-py2.4.egg --prefix=~ + sh setuptools-0.6c9-py2.4.egg --prefix=~ You can use ``--help`` to get a full options list, but we recommend consulting the `EasyInstall manual`_ for detailed instructions, especially `the section @@ -80,7 +80,7 @@ example, doing the following at a Cygwin bash prompt will install setuptools for the **Windows** Python found at ``C:\\Python24``:: ln -s /cygdrive/c/Python24/python.exe python2.4 - PATH=.:$PATH sh setuptools-0.6c4-py2.4.egg + PATH=.:$PATH sh setuptools-0.6c9-py2.4.egg rm python2.4 diff --git a/pkg_resources.py b/pkg_resources.py index 4a9152b..0b96fa0 100644 --- a/pkg_resources.py +++ b/pkg_resources.py @@ -1780,7 +1780,7 @@ def parse_version(s): The algorithm assumes that strings like "-" and any alpha string that alphabetically follows "final" represents a "patch level". So, "2.4-1" is assumed to be a branch or patch of "2.4", and therefore "2.4.1" is - considered newer than "2.4-1", whic in turn is newer than "2.4". + considered newer than "2.4-1", which in turn is newer than "2.4". Strings like "a", "b", "c", "alpha", "beta", "candidate" and so on (that come before "final" alphabetically) are assumed to be pre-release versions, @@ -1789,7 +1789,8 @@ def parse_version(s): Finally, to handle miscellaneous cases, the strings "pre", "preview", and "rc" are treated as if they were "c", i.e. as though they were release candidates, and therefore are not as new as a version string that does not - contain them. + contain them, and "dev" is replaced with an '@' so that it sorts lower than + than any other pre-release tag. """ parts = [] for part in _parse_version_parts(s.lower()): diff --git a/wikiup.cfg b/wikiup.cfg new file mode 100755 index 0000000..5861915 --- /dev/null +++ b/wikiup.cfg @@ -0,0 +1,5 @@ +[PEAK] +EasyInstall = EasyInstall.txt +setuptools = setuptools.txt +PkgResources = pkg_resources.txt +EggFormats = doc/formats.txt -- cgit v1.2.1