summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorholger krekel <holger@merlinux.eu>2010-10-17 12:03:43 +0200
committerholger krekel <holger@merlinux.eu>2010-10-17 12:03:43 +0200
commit4d3cdec55f873e89942dbe59b9fb0618aa3bc474 (patch)
treeff2fc6a1e76e1f669b8935c5c3b35fcdfffbb631 /doc
parent4d876e495c5408ecaeab88b720fc3a28a7efdd21 (diff)
downloadtox-4d3cdec55f873e89942dbe59b9fb0618aa3bc474.tar.gz
changed/refined indexserver handling, now dependencies can be scoped, see added docs.
Diffstat (limited to 'doc')
-rw-r--r--doc/config.txt14
-rw-r--r--doc/example/basic.txt24
2 files changed, 32 insertions, 6 deletions
diff --git a/doc/config.txt b/doc/config.txt
index fae93f2..f9cf80f 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -19,6 +19,7 @@ List of optional global options::
distdir=path # defaults to {toxworkdir}/dist
distshare=path # defaults to {homedir}/.tox/distshare
envlist=ENVLIST # defaults to the list of all environments
+
``tox`` autodetects if it is running in a Hudson_ context
(by checking for existence of the ``HUDSON_URL`` environment variable)
@@ -27,7 +28,15 @@ and will first lookup global tox settings in this section::
[tox:hudson]
... # override [tox] settings for the hudson context
# note: for hudson distshare defaults to ``{toxworkdir}/distshare``.
+
+.. confval:: indexserver=
+ name URL
+ name URL
+ ...
+ Definition of "name -> URL" mappings which can be used in
+ dependency specifications to install packages from different
+ indexservers.
envlist setting
+++++++++++++++++++++++++
@@ -104,11 +113,6 @@ Complete list of settings that you can put into ``testenv*`` sections:
passed to easy_install/pip for processing. It usually can be a file,
and URL or a package name.
-.. confval:: indexserver=URL
-
- The Index server to use. When nothing is specified the default
- of the installation tool (easy_install or pip) will be used.
-
.. confval:: upgrade=True|False(default)
Install dependencies in "upgrade" mode by passing upgrade flag to install tools.
diff --git a/doc/example/basic.txt b/doc/example/basic.txt
index f46b401..c3b4de6 100644
--- a/doc/example/basic.txt
+++ b/doc/example/basic.txt
@@ -51,13 +51,35 @@ using a different PyPI server
.. versionadded: 0.9
To install dependencies and packages from a different
-PyPI servertype::
+PyPI server type::
tox --indexserver http://pypi.testrun.org
This causes both the internal pip and easy-install steps
to use the specified server for upgrading.
+installing dependencies from multiple PyPI server
+---------------------------------------------------
+
+.. versionadded: 0.9
+
+You can instrument tox to install dependencies from
+different PyPI servers, example::
+
+ [tox]
+ indexserver =
+ DEV http://mypypiserver.org
+
+ [testenv]
+ deps =
+ docutils # comes from standard PyPI
+ DEV mypackage # will come from custom PYPI above
+
+Note that the ``--indexserver`` command line overrides
+the default index server, not the ``DEV`` one here.
+This will cause both the internal pip and easy-install steps
+to use the specified servers accordingly.
+
upgrading packages
-----------------------------------------------