X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=README.md;h=0ce3c240145c7b5ad2a599082201a37a6a5b4b08;hb=8893827db2c2ecf7e3bf3ee47c6e1d3c2a9560c7;hp=42367158b11236ef08b3d5d0950e67eb945cca29;hpb=3cde2303717915affb9bc5f8f6df6e075d8168d9;p=releng%2Fglobal-jjb.git

diff --git a/README.md b/README.md
index 42367158..0ce3c240 100644
--- a/README.md
+++ b/README.md
@@ -78,9 +78,14 @@ Trigger global configuration.
 **jenkins-ssh-credential**: The name of the Jenkins Credential to use for ssh
 connections.
 
-If you are using GitHub then there is one more parameter which
+If you are using GitHub then there are two more parameters which
 will need to be placed in the defaults.yaml
 
+**git-url**: This should be set to the base URL of your GitHub. In
+general this should be https://github.com. If you are using GitHub
+Enterprise, or some other GitHub-style system, then it should be
+whatever your installation base URL is.
+
 **github-org**: The name of the GitHub organization.
 
 defaults.yaml:
@@ -126,14 +131,52 @@ ci-management.yaml:
 
 Required parameters:
 
-**project**: is the project repo as defined in Gerrit.
+**project**: is the project repo as defined in source control.
+**project-name**: is a custom name to call the job in Jenkins.
+**build-node**: is the name of the builder to use when building (Jenkins label).
+
+Optional parameters:
+
+**branch**: is the git branch to build from.
+**jjb-version**: is the version of JJB to install in the build minion.
+
+## Deploying Python jobs
+
+We provide the following Python jobs templates:
+
+### {project-name}-tox-verify-{stream}
+
+This job can be used to call python-tox to run builds and tests. The most common
+usage of this job is to run the Coala linter against projects.
+
+```
+- project:
+    name: builder
+    jobs:
+        - '{project-name}-tox-verify-{stream}'
+
+    project-name: builder
+    project: releng/builder
+    build-node: centos7-java-builder-2c-4g
+    stream: master
+```
+
+Required parameters:
+
+**project**: is the project repo as defined in source control.
 **project-name**: is a custom name to call the job in Jenkins.
 **build-node**: is the name of the builder to use when building (Jenkins label).
+**stream**: typically `master` or matching whatever branch is being built. This
+            is a useful keywords to map a release codename to a branch. For
+            example OpenDaylight uses this to map stream=carbon to
+            branch=stable/carbon.
 
 Optional parameters:
 
 **branch**: is the git branch to build from.
 **jjb-version**: is the version of JJB to install in the build minion.
+**tox-dir**: directory containing tox.ini file (default: '')
+**tox-envs**: tox environments to run (default: '')
 
 ## Archiving logs in Jobs