summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarl Meyer <carl@oddbird.net>2013-08-08 18:07:49 -0600
committerCarl Meyer <carl@oddbird.net>2013-08-08 18:07:49 -0600
commita8f9473db1c3018cd0c030a502155019ae8c1786 (patch)
tree7c5fc67ad65ea369c0be7d8bfb4c43e63b9abd3f
parentad245c7215ca9227c75f320f9c4474103bc3c555 (diff)
downloadtox-a8f9473db1c3018cd0c030a502155019ae8c1786.tar.gz
Add documentation for install_command option.
-rw-r--r--doc/config.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/doc/config.txt b/doc/config.txt
index 0cfef42..92a89f4 100644
--- a/doc/config.txt
+++ b/doc/config.txt
@@ -76,6 +76,22 @@ Complete list of settings that you can put into ``testenv*`` sections:
For eventually performing a call to ``subprocess.Popen(args, ...)``
``args`` are determined by splitting the whole command by whitespace.
+.. confval:: install_command=ARGV
+
+ .. versionadded:: 1.6
+
+ the command to be used for installing packages into the virtual
+ environment; both the sdist for the package under test and any
+ defined dependencies. Must contain the substitution key
+ ``{packages}`` which will be replaced by the packages to
+ install. May also contain the substitution key ``{opts}``, which
+ will be replaced by the ``-i`` option to specify index server
+ (according to :confval:`indexserver` and the ``:indexserver:dep``
+ syntax of :confval:`deps`) and the ``--download-cache`` option, if
+ you've specified :confval:`downloadcache` and your
+ :confval:`install_command` begins with ``pip``. **default**: ``pip
+ install {opts} {packages}``
+
.. confval:: whitelist_externals=MULTI-LINE-LIST
each line specifies a command name (in glob-style pattern format)