Docs: remove reference to detox 41/68041/3
authorGuillaume Lambert <guillaume.lambert@orange.com>
Thu, 17 Jun 2021 09:36:01 +0000 (11:36 +0200)
committerGuillaume Lambert <guillaume.lambert@orange.com>
Thu, 17 Jun 2021 10:18:54 +0000 (12:18 +0200)
Detox globaljjb support was removed in a previous commit.
1873622e1b5bf98150db6850901d190dd6c35422
Parallel jobs are now natively supported by tox since version 3.7.0
thanks to the option "-p" / "--parallel".
This new option offers more possibilities than detox and other options
have also been introduced to tune tox behavior in parallel mode.
The configuration choices made in globaljjb must be clarified.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I82c88ea96ee1332b95ab13f0b7dbf2a04e00f37a

docs/jjb/lf-python-jobs.rst

index 0f02b42..48f3588 100644 (file)
@@ -43,8 +43,8 @@ Creates a Tox virtual environment and invokes tox.
 
 :Required Parameters:
 
-    :parallel: Boolean. If true use detox (distributed tox);
-        else use regular tox.
+    :parallel: Boolean. If true use tox with the options "--parallel auto"
+        and "--parallel-live" to parallelize jobs in the envlist;
 
 
 Job Templates
@@ -202,6 +202,8 @@ https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
     :mvn-version: Version of maven to use. (default: mvn35)
     :parallel: Boolean indicator for tox to run tests in parallel or series.
         (default: false, in series)
+        If true use tox with the options "--parallel auto" and "--parallel-live"
+        to parallelize jobs in the envlist.
     :pre-build-script: Shell script to execute before the Sonar builder.
         For example, install prerequisites or move files to the repo root.
         (default: a string with a shell comment)
@@ -293,6 +295,8 @@ Plug-in configurations
     :github-url: URL for Github. (default: https://github.com)
     :parallel: Boolean indicator for tox to run tests in parallel or series.
         (default: false, in series)
+        If true use tox with the options "--parallel auto" and "--parallel-live"
+        to parallelize jobs in the envlist.
     :pre-build-script: Shell script to run before tox. Useful for setting up
         dependencies. (default: a string with a shell comment)
     :python-version: Python version to invoke pip install of tox-pyenv
@@ -402,7 +406,9 @@ variables before running.
         For example, install prerequisites or move files to the repo root.
         (default: a string with a shell comment)
     :parallel: Boolean indicator for tox to run tests in parallel or series.
-       (default: false, in series)
+        (default: false, in series)
+        If true use tox with the options "--parallel auto" and "--parallel-live"
+        to parallelize jobs in the envlist.
     :python-version: Python version to invoke pip install of tox-pyenv
         (default: python2)
     :stream: Keyword representing a release code-name.
@@ -569,7 +575,9 @@ is optional, it defaults to pypi.org.
     :mvn-params: Parameters to pass to the mvn CLI. (default: '')
     :mvn-version: Version of maven to use. (default: mvn35)
     :parallel: Boolean indicator for tox to run tests in parallel or series.
-       (default: false, in series)
+        (default: false, in series)
+        If true use tox with the options "--parallel auto" and "--parallel-live"
+        to parallelize jobs in the envlist.
     :pre-build-script: Shell script to execute before the tox builder. For
         example, install system prerequisites. (default: a shell comment)
     :pypi-repo: Key for the PyPI target repository in the .pypirc file,
@@ -681,7 +689,9 @@ is optional, it defaults to pypi.org.
     :mvn-params: Parameters to pass to the mvn CLI. (default: '')
     :mvn-version: Version of maven to use. (default: mvn35)
     :parallel: Boolean indicator for tox to run tests in parallel or series.
-       (default: false, in series)
+        (default: false, in series)
+        If true use tox with the options "--parallel auto" and "--parallel-live"
+        to parallelize jobs in the envlist.
     :pre-build-script: Shell script to execute before the tox builder. For
         example, install system prerequisites. (default: a shell comment)
     :pypi-repo: Key for the PyPI target repository in the .pypirc file,
@@ -797,7 +807,9 @@ pyenv variables before running.
     :mvn-params: Parameters to pass to the mvn CLI. (default: '')
     :mvn-version: Version of maven to use. (default: mvn35)
     :parallel: Boolean indicator for tox to run tests in parallel or series.
-       (default: false, in series)
+        (default: false, in series)
+        If true use tox with the options "--parallel auto" and "--parallel-live"
+        to parallelize jobs in the envlist.
     :pre-build-script: Shell script to execute before the tox builder. For
         example, install system prerequisites. (default: a shell comment)
     :python-version: Python version to invoke pip install of tox-pyenv