From: Thanh Ha <thanh.ha@linuxfoundation.org>
Date: Fri, 12 Jan 2018 19:10:06 +0000 (-0500)
Subject: Document pyenv usage in the tox job
X-Git-Tag: v0.17.0~1
X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=commitdiff_plain;h=refs%2Fchanges%2F84%2F8384%2F3;p=releng%2Fglobal-jjb.git

Document pyenv usage in the tox job

Change-Id: Id07a1e4065b03489260dfe1d0b86cacf8d60238d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
---

diff --git a/docs/jjb/lf-python-jobs.rst b/docs/jjb/lf-python-jobs.rst
index a0477248..2a8e66b7 100644
--- a/docs/jjb/lf-python-jobs.rst
+++ b/docs/jjb/lf-python-jobs.rst
@@ -44,7 +44,15 @@ Job Templates
 Tox Verify
 ----------
 
-Tox runner to verify a project
+Tox runner to verify a project. This job is pyenv aware so if the image
+contains an installation of pyenv at /opt/pyenv it will pick it up and run
+Python tests with the appropriate Python versions. This job will set the
+following pyenv variables before running.
+
+.. code:: bash
+
+   export PYENV_ROOT="/opt/pyenv"
+   export PATH="$PYENV_ROOT/bin:$PATH"
 
 :Template Names: