Skip to content

Commit d41bd62

Browse files
authored
Document problems with plugin and provision env (refs #2469) (#2511)
1 parent 8282e9e commit d41bd62

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

Diff for: docs/changelog/2469.doc.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Documented problems with plugin and provision env - by :user:`ziima`.

Diff for: docs/config.rst

+5
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,11 @@ Global settings are defined under the ``tox`` section as:
7676
When tox is invoked with the ``--no-provision`` flag,
7777
the provision won't be attempted, tox will fail instead.
7878

79+
.. warning::
80+
81+
The new virtual environment will only contain dependencies specified by the :conf:`requires` keyword.
82+
Any plugin used by the `tox` executable and not specified in `requires` explicitely won't be used for subsequent tasks.
83+
7984
.. conf:: toxworkdir ^ PATH ^ {toxinidir}/.tox
8085

8186
Directory for tox to generate its environments into, will be created if it does not exist.

Diff for: docs/plugins.rst

+5
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,11 @@ and locations of all installed plugins::
7272
registered plugins:
7373
tox-travis-0.10 at /home/ob/.virtualenvs/tmp/lib/python3.6/site-packages/tox_travis/hooks.py
7474

75+
.. warning::
76+
77+
If the `tox.ini` used specifies :conf:`minversion` or :conf:`requires` options then registered plugins may not have any effect.
78+
See :conf:`provision_tox_env` for details.
79+
7580

7681
Creating a plugin
7782
-----------------

0 commit comments

Comments
 (0)