X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;ds=sidebyside;f=README.md;h=01388fc4bddef63200d30b098a9851d142022ae0;hb=refs%2Fchanges%2F06%2F5106%2F2;hp=3bad6b0fc198074ba095012cc621b6f2b93c0ebf;hpb=0912741cdcac047d4ef2e0d689a0260debc92b32;p=releng%2Fglobal-jjb.git

diff --git a/README.md b/README.md
index 3bad6b0f..01388fc4 100644
--- a/README.md
+++ b/README.md
@@ -131,4 +131,22 @@ Required parameters:
 Optional parameters:
 
 **branch**: is the git branch to build from.
+**git-url**: is used to override the GIT_URL environment variable. Should not
+             be necessary in most cases. Mainly used by LF projects such as
+             global-jjb and lftools.
 **jjb-version**: is the version of JJB to install in the build minion.
+
+## Archiving logs in Jobs
+
+There are 2 ways supported for archiving log information:
+
+1) Job creates $WORKSPACE/archives directory and places logs there
+
+In this method the entire archives directory will be pushed to the log server
+in the same structure as configured in the archives directory.
+
+2) Via job variable ARCHIVE_ARTIFACTS using globstar patterns.
+
+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.