add documentation for globbed parameter feature

change I5bb1074 added a globbed parameter feature for updating and
deleting JJB jobs but did not provide documentation for it.
Hopefully this change will help users discover this feature.

Change-Id: I6e527c818f25a5aa061a19308f22495221e3dc93
This commit is contained in:
Khai Do 2014-10-14 16:06:24 -07:00
parent 55cf1ec36b
commit 66261c384d

@ -183,6 +183,19 @@ There is also a command to delete **all** jobs.
jenkins-jobs delete-all
Globbed Parameters
^^^^^^^^^^^^^^^^^^
Jenkins job builder supports globbed parameters to identify jobs from a set of
definition files. This feature only supports JJB managed jobs.
To update jobs that only have 'foo' in their name::
jenkins-jobs update ./myjobs \*foo\*
To delete jobs that only have 'foo' in their name::
jenkins-jobs delete --path ./myjobs \*foo\*
.. rubric:: Footnotes
.. [#f1] The cache default location is at ``~/.cache/jenkins_jobs``, which
can be overridden by setting the ``XDG_CACHE_HOME`` environment