diff options
author | holger krekel <holger.krekel@gmail.com> | 2013-07-11 11:13:15 +0200 |
---|---|---|
committer | holger krekel <holger.krekel@gmail.com> | 2013-07-11 11:13:15 +0200 |
commit | 47f06113a42edafc693caf9d97d8e724b3f11051 (patch) | |
tree | 1bf502b2aa34017da26d267f0cb50d581285c249 /doc | |
parent | 72d6b90acf35e3a9b6dd8e039063028245fae658 (diff) | |
parent | 08c2aaac036791e2be8b0e634d722ba0971b5216 (diff) | |
download | tox-47f06113a42edafc693caf9d97d8e724b3f11051.tar.gz |
Merged in lukaszb/tox (pull request #45)
Created initial documentation for development environments -- related with #101
Diffstat (limited to 'doc')
-rw-r--r-- | doc/conf.py | 2 | ||||
-rw-r--r-- | doc/config.txt | 19 | ||||
-rw-r--r-- | doc/example/basic.txt | 16 | ||||
-rw-r--r-- | doc/index.txt | 3 | ||||
-rw-r--r-- | doc/install.txt | 4 |
5 files changed, 37 insertions, 7 deletions
diff --git a/doc/conf.py b/doc/conf.py index c6e55ed..f643b48 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -48,7 +48,7 @@ copyright = u'2013, holger krekel and others' # built documents. # # The short X.Y version. -release = version = "1.4.3" +release = version = "1.5.0" # The full version, including alpha/beta/rc tags. # The language for content autogenerated by Sphinx. Refer to documentation diff --git a/doc/config.txt b/doc/config.txt index e30e57d..e5c937a 100644 --- a/doc/config.txt +++ b/doc/config.txt @@ -75,6 +75,16 @@ 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:: whitelist_externals=MULTI-LINE-LIST + + each line specifies a command name (in glob-style pattern format) + which can be used in the ``commands`` section without triggering + a "not installed in virtualenv" warning. Example: if you use the + unix ``make`` for running tests you can list ``whitelist_externals=make`` + or ``whitelist_externals=/usr/bin/make`` if you want more precision. + If you don't want tox to issue a warning in any case, just use + ``whitelist_externals=*`` which will match all commands (not recommended). + .. confval:: changedir=path change to this working directory when executing the test command. @@ -115,9 +125,12 @@ Complete list of settings that you can put into ``testenv*`` sections: .. confval:: distribute=True|False - Set to ``False`` if you want to use setuptools_ instead of the default - distribute_ in the virtual environment. - **default:** True. + Set to ``True`` if you want to use distribute_ instead of the default + setuptools_ in the virtual environment. Prior to tox-1.5 the + default was True and now is False, meaning ``setuptools`` is used + (note that setuptools-0.7 merged with distribute). In future versions + of tox this option might be ignored and setuptools always chosen. + **default:** False. .. confval:: sitepackages=True|False diff --git a/doc/example/basic.txt b/doc/example/basic.txt index 6c92fac..031c4f9 100644 --- a/doc/example/basic.txt +++ b/doc/example/basic.txt @@ -44,6 +44,22 @@ Available "default" test environments names are:: However, you can also create your own test environment names, see some of the examples in :doc:`examples <../examples>`. +whitelisting a non-virtualenv commands +----------------------------------------------- + +.. versionadded:: 1.5 + +Sometimes you may want to use tools not contained in your +virtualenv such as ``make``, ``bash`` or others. To avoid +warnings you can use the ``whitelist_externals`` testenv +configuration:: + + # content of tox.ini + [testenv] + whitelist_externals = make + /bin/bash + + .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _multiindex: diff --git a/doc/index.txt b/doc/index.txt index 20d65d4..1838b3b 100644 --- a/doc/index.txt +++ b/doc/index.txt @@ -1,7 +1,8 @@ Welcome to the tox automation project =============================================== -.. note:: Upcoming: `professional testing with pytest and tox <http://www.python-academy.com/courses/specialtopics/python_course_testing.html>`_ , 24th-26th June 2013, Leipzig. +.. + Upcoming: `professional testing with pytest and tox <http://www.python-academy.com/courses/specialtopics/python_course_testing.html>`_ , 24th-26th June 2013, Leipzig. vision: standardize testing in Python --------------------------------------------- diff --git a/doc/install.txt b/doc/install.txt index 6394920..c794692 100644 --- a/doc/install.txt +++ b/doc/install.txt @@ -4,13 +4,13 @@ tox installation Install info in a nutshell ---------------------------------- -**Pythons**: CPython 2.4-3.2, Jython-2.5.1, pypy-1.5 +**Pythons**: CPython 2.4-3.3, Jython-2.5.1, pypy-1.9ff **Operating systems**: Linux, Windows, OSX, Unix **Installer Requirements**: setuptools_ or Distribute_ -**License**: GPLv2 or later +**License**: MIT license **hg repository**: http://bitbucket.org/hpk42/tox |