Make gerrit-branch-lock work for all proj/branches

[releng/global-jjb.git] / docs / jjb / lf-docker-jobs.rst

diff --git a/docs/jjb/lf-docker-jobs.rst b/docs/jjb/lf-docker-jobs.rst
index 4a91dc7..09abbbb 100644 (file)
--- a/docs/jjb/lf-docker-jobs.rst
+++ b/docs/jjb/lf-docker-jobs.rst
@@ -27,7 +27,8 @@ If container-tag-method: yaml-file, the tag is obtained using
 the yq command, which requires that the repository has a YAML file named
 'container-tag.yaml'. The script checks the docker-root directory by
 default or the directory specified by parameter container-tag-yaml-dir.
-An example file appears below.
+An example file appears below. Optionally, teams can call their own script to
+handle the docker tagging differently.
 
 
 lf-docker-build
@@ -54,7 +55,9 @@ Executes a docker build task.
     - gerrit-docker-verify
     - github-docker-verify
 
-:Comment Trigger: recheck|reverify
+:Comment Trigger: **recheck|reverify** post a comment with one of the
+    triggers to launch this job manually. Do not include any other
+    text or vote in the same comment.
 
 :Required parameters:
 
@@ -77,6 +80,8 @@ Executes a docker build task.
         (default: latest)
     :container-tag-yaml-dir: Directory with container-tag.yaml. (default: $DOCKER_ROOT)
     :docker-build-args: Additional arguments for the docker build command.
+    :docker-get-container-tag-script: Pointer to script to handle docker tags.
+        (default: ../shell/docker-get-container-tag.sh)
     :docker-root: Build directory within the repo. (default: $WORKSPACE, the repo root)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
     :pre_docker_build_script: Build script to execute before the main verify
@@ -116,7 +121,9 @@ Executes a docker build task and publishes the resulting images to a specified D
     - gerrit-docker-merge
     - github-docker-merge
 
-:Comment Trigger: remerge
+:Comment Trigger: **remerge** post a comment with the trigger to launch
+    this job manually. Do not include any other text or vote in the
+    same comment.
 
 :Required parameters:
 
@@ -144,6 +151,8 @@ Executes a docker build task and publishes the resulting images to a specified D
         one may want to provide more than 1 cron timer. No default. Use
         '@daily' to run daily or 'H H * * 0' to run weekly.
     :docker-build-args: Additional arguments for the docker build command.
+    :docker-get-container-tag-script: Pointer to script to handle docker tags.
+        (default: ../shell/docker-get-container-tag.sh)
     :docker-root: Build directory within the repo. (default: $WORKSPACE, the repo root)
     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
     :pre_docker_build_script: Build script to execute before the main merge