Add documentation for XDG_CACHE_HOME

This patch documents the XDG_CACHE_HOME environment variable in JJB.

Fixes bug 1193450

Change-Id: I57cf59c8723aa04e20801f32a81b573c9d096b48
This commit is contained in:
Khai Do 2013-09-09 11:49:37 -07:00
parent e8c09ea6c0
commit 73df0ac7a7

@ -67,7 +67,7 @@ can run::
jenkins-jobs update /path/to/config
Which will upload the configurations to Jenkins if needed. Jenkins Job
Builder maintains, for each host, a cache of previously configured jobs,
Builder maintains, for each host, a cache [#f1]_ of previously configured jobs,
so that you can run that command as often as you like, and it will only
update the configuration in Jenkins if the defined configuration has
changed since the last time it was run. Note: if you modify a job
@ -78,3 +78,8 @@ To update a specific list of jobs, simply pass them as additional
arguments after the configuration path. To update Foo1 and Foo2 run::
jenkins-jobs update /path/to/config Foo1 Foo2
.. Running:: Footnotes
.. [#f1] The cache default location is at ``~/.cache/jenkins_jobs``, which
can be overriden by setting the ``XDG_CACHE_HOME`` environment variable.