doc updates for VIRTUALENVWRAPPER_VIRTUALENV

Author: dhellmann

docs/en/history.rst

@@ -18,6 +18,9 @@ dev
     from Paul McLanahan (:bbuser:`pmclanahan`). The new command
     changes the configuration of the active virtualenv to enable or
     disable the global ``site-packages`` directory.
+  - Fixed some tests that were failing under ksh on Ubuntu 10.10.
+  - Document the :ref:`VIRTUALENVWRAPPER_VIRTUALENV
+    <variable-VIRTUALENVWRAPPER_VIRTUALENV>` variable.
 
 2.6.3
 
@@ -34,7 +37,7 @@ dev
     Tetsuya Morimoto.
   - Incorporate a suggestion from Ales Zoulek to let the user specify
     the virtualenv binary through an environment variable
-    (``VIRTUALENVWRAPPER_VIRTUALENV``).
+    (:ref:`VIRTUALENVWRAPPER_VIRTUALENV <variable-VIRTUALENVWRAPPER_VIRTUALENV>`).
 
 2.6.1
 

docs/en/install.rst

@@ -64,27 +64,36 @@ and the location of the script installed with this package::
 After editing it, reload the startup file (e.g., run: ``source
 ~/.bashrc``).
 
-Python Interpreter and $PATH
-============================
+.. _variable-VIRTUALENVWRAPPER_VIRTUALENV:
 
-During startup, ``virtualenvwrapper.sh`` finds the first ``python`` on
-the ``$PATH`` and remembers it to use later.  This eliminates any
-conflict as the ``$PATH`` changes, enabling interpreters inside
-virtual environments where virtualenvwrapper is not installed.
-Because of this behavior, it is important for the ``$PATH`` to be set
-**before** sourcing ``virtualenvwrapper.sh``.  For example::
+.. _variable-VIRTUALENVWRAPPER_PYTHON:
+
+Python Interpreter, virtualenv, and $PATH
+=========================================
+
+During startup, ``virtualenvwrapper.sh`` finds the first ``python``
+and ``virtualenv`` programs on the ``$PATH`` and remembers them to use
+later.  This eliminates any conflict as the ``$PATH`` changes,
+enabling interpreters inside virtual environments where
+virtualenvwrapper is not installed or where different versions of
+virtualenv are installed.  Because of this behavior, it is important
+for the ``$PATH`` to be set **before** sourcing
+``virtualenvwrapper.sh``.  For example::
 
     export PATH=/usr/local/bin:$PATH
     source /usr/local/bin/virtualenvwrapper.sh
 
 To override the ``$PATH`` search, set the variable
 ``VIRTUALENVWRAPPER_PYTHON`` to the full path of the interpreter to
-use (also **before** sourcing ``virtualenvwrapper.sh``).  For
-example::
+use and ``VIRTUALENVWRAPPER_VIRTUALENV`` to the full path of the
+``virtualenv`` binary to use. Both variables *must* be set before
+sourcing ``virtualenvwrapper.sh``.  For example::
 
     export VIRTUALENVWRAPPER_PYTHON=/usr/local/bin/python
+    export VIRTUALENVWRAPPER_VIRTUALENV=/usr/local/bin/virtualenv
     source /usr/local/bin/virtualenvwrapper.sh
 
+
 Quick-Start
 ===========