diff --git a/doc/source/plugins/plugin.rst b/doc/source/plugins/plugin.rst index b1fd6f88c1..07713180d9 100644 --- a/doc/source/plugins/plugin.rst +++ b/doc/source/plugins/plugin.rst @@ -345,6 +345,8 @@ isolate the Tempest install from the rest of your system so just installing the plugin package on your system and then running Tempest inside a venv will not work. -Tempest also exposes a tox job, all-plugin, which will setup a tox virtualenv -with system site-packages enabled. This will let you leverage tox without -requiring to manually install plugins in the tox venv before running tests. +For example, you can use tox to install and run tests from a tempest plugin like +this:: + + [~/tempest] $ tox -e venv-tempest -- pip install (path to the plugin directory) + [~/tempest] $ tox -e all diff --git a/roles/run-tempest-26/README.rst b/roles/run-tempest-26/README.rst index 3643edb4e4..8ff1656730 100644 --- a/roles/run-tempest-26/README.rst +++ b/roles/run-tempest-26/README.rst @@ -21,7 +21,7 @@ variable (through the `register` statement). A regular expression used to select the tests. It works only when used with some specific tox environments - ('all', 'all-plugin'.) + ('all', 'all-site-packages') In the following example only api scenario and third party tests will be executed. @@ -47,7 +47,7 @@ variable (through the `register` statement). A regular expression used to skip the tests. It works only when used with some specific tox environments - ('all', 'all-plugin'.) + ('all', 'all-site-packages'). :: vars: diff --git a/roles/run-tempest/README.rst b/roles/run-tempest/README.rst index d9f855ae63..04db849f46 100644 --- a/roles/run-tempest/README.rst +++ b/roles/run-tempest/README.rst @@ -21,7 +21,7 @@ variable (through the `register` statement). A regular expression used to select the tests. It works only when used with some specific tox environments - ('all', 'all-plugin'.) + ('all', 'all-site-packages'). In the following example only api scenario and third party tests will be executed. @@ -56,7 +56,7 @@ variable (through the `register` statement). A regular expression used to skip the tests. It works only when used with some specific tox environments - ('all', 'all-plugin'.) + ('all', 'all-site-packages'). :: vars: