tcwg_kernel-build.sh: Document ${rr[]} elements

Change-Id: Ib2b7461f191a0a47df5ee61f21c2279c20707268

1 files changed, 32 insertions, 4 deletions

diff --git a/tcwg_kernel-build.sh b/tcwg_kernel-build.sh
index 875c6216..e8e3ce7b 100755
--- a/tcwg_kernel-build.sh
+++ b/tcwg_kernel-build.sh
@@ -43,10 +43,6 @@ if [ x"$target" = x"native" ]; then
     target=$(uname -m)
 fi
 
-# Baseline branch name for current configuration.  These branches are
-# present in all above git repos.
-rr[baseline_branch]="linaro-local/ci/tcwg_kernel/$toolchain-${rr[${toolchain}_version]}-$target-${rr[linux_version]}-$linux_config"
-
 # We are not going to push any results for a one-off build.
 if [ x"$current_project" = x"none" ]; then
     git_read_only=true
@@ -96,14 +92,46 @@ fi
 
 run_step_init "$start_at" "$finish_at" "$top_artifacts" "$base_artifacts_opt" "$verbose"
 
+# Pretty name for PROJECT's version
+#rr[PROJECT_version]
+
+# PROJECT's git url
+#rr[PROJECT_url]
+
+# PROJECT's git revision parsable by git rev-parse.
+#rr[PROJECT_rev]
+
+# Baseline branch name for current configuration.  These branches are
+# present in all above git repos.
+rr[baseline_branch]="linaro-local/ci/tcwg_kernel/$toolchain-${rr[${toolchain}_version]}-$target-${rr[linux_version]}-$linux_config"
+
+# PROJECT that we are testing in this build.  Use ${rr[current_rev]} for
+# this project, and ${rr[baseline_branch]} for all other projects.
 rr[current_project]="$current_project"
+
+# Git revision of ${rr[current_project]} to test.
 rr[current_rev]="$current_rev"
+
+# Helper variable, only used in asserts.
 rr[git_read_only]="$git_read_only"
+
+# Linux config to build in build_linux.
 rr[linux_config]="$linux_config"
+
+# Run mode: bisect or non-bisect.  In bisect mode we do a couple things
+# slightly differently (e.g., don't touch repo in clone_repo() ).
 rr[mode]="$mode"
+
+# Ignore failures in check_regression, which forces update_baseline().
 rr[reset_baseline]="$reset_baseline"
+
+# Target architecture to build for: arm or aarch64.
 rr[target]="$target"
+
+# Toolchain to use: gnu or llvm.
 rr[toolchain]="$toolchain"
+
+# Top-level artifacts directory.
 rr[top_artifacts]="$top_artifacts"
 
 # Reset artifacts to an empty state.  ${rr[top_artifacts]}/results is the most