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

diff --git a/README.md b/README.md
index 0ce3c240..63cdff37 100644
--- a/README.md
+++ b/README.md
@@ -86,6 +86,10 @@ 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.
 
+**git-clone-url**: This is the clone prefix used by GitHub jobs. This
+should be set to either the same thing as **git-url** or the
+'git@github.com:' including the trailing ':'
+
 **github-org**: The name of the GitHub organization.
 
 defaults.yaml:
@@ -192,3 +196,13 @@ in the same structure as configured in the archives directory.
 In this method a job can define a globstar for example ``**/*.log`` which then
 causes the archive script to do a globstar search for that pattern and archives
 any files it finds matching.
+
+## Appendix
+
+### ShellCheck
+
+If ShellCheck is being used to lint global-jjb or any projects that include
+global-jjb as part of their project (common with ci-management repos) then
+a minimum version of ShellCheck 0.4.x is required as the shell scripts in
+this repo uses annotations that were introduced in 0.4..
+