X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-python-jobs.rst;h=a04772487551be110e3198978fd3c8d7aa2d9721;hb=refs%2Fchanges%2F80%2F8380%2F3;hp=02fff2b377c5acc63485f6786b277eaa066b4d6a;hpb=391e8138f528a720604ed9da7bda949b5e56fbec;p=releng%2Fglobal-jjb.git

diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst
index 02fff2b3..a0477248 100644
--- a/docs/jjb/lf-python-jobs.rst
+++ b/docs/jjb/lf-python-jobs.rst
@@ -23,6 +23,21 @@ Jobs for Python projects using GitHub.
 
     - github-tox-verify
 
+
+Macros
+======
+
+lf-tox-install
+--------------
+
+Runs a shell script that installs tox in a Python virtualenv.
+
+:Required Parameters:
+
+    :python-version: Base Python version to use in the virtualenv. For example
+        python2 or python3.
+
+
 Job Templates
 =============
 
@@ -40,8 +55,8 @@ Tox runner to verify a project
 :Required Parameters:
 
     :build-node: The node to run build on.
-    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
-        be configured in defaults.yaml)
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
 
 :Optional Parameters:
 
@@ -49,7 +64,9 @@ Tox runner to verify a project
     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
     :build-timeout: Timeout in seconds before aborting build. (default: 10)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
-    :stream: Keyword that can be used to represent a release code-name.
+    :python-version: Version of Python to configure as a base in virtualenv.
+        (default: python3)
+    :stream: Keyword representing a release code-name.
         Often the same as the branch. (default: master)
     :submodule-recursive: Whether to checkout submodules recursively.
         (default: true)