Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document problems with plugin and provision env (refs #2469) #2511

Merged
merged 1 commit into from Oct 8, 2022
+11 −0
Merged

Document problems with plugin and provision env (refs #2469) #2511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/changelog/2469.doc.rst
View file
Open in desktop
@@ -0,0 +1 @@
Documented problems with plugin and provision env - by :user:`ziima`.
5 changes: 5 additions & 0 deletions docs/config.rst
View file
Open in desktop
Expand Up @@ -76,6 +76,11 @@ Global settings are defined under the ``tox`` section as:
When tox is invoked with the ``--no-provision`` flag,
the provision won't be attempted, tox will fail instead.

.. warning::

The new virtual environment will only contain dependencies specified by the :conf:`requires` keyword.
Any plugin used by the `tox` executable and not specified in `requires` explicitely won't be used for subsequent tasks.

.. conf:: toxworkdir ^ PATH ^ {toxinidir}/.tox

Directory for tox to generate its environments into, will be created if it does not exist.
Expand Down
5 changes: 5 additions & 0 deletions docs/plugins.rst
View file
Open in desktop
Expand Up @@ -72,6 +72,11 @@ and locations of all installed plugins::
registered plugins:
tox-travis-0.10 at /home/ob/.virtualenvs/tmp/lib/python3.6/site-packages/tox_travis/hooks.py

.. warning::

If the `tox.ini` used specifies :conf:`minversion` or :conf:`requires` options then registered plugins may not have any effect.
See :conf:`provision_tox_env` for details.


Creating a plugin
-----------------
Expand Down