Clarify 'trigger-parameterized-builds' description

Documentation on trigger-parameterized-builds option 'fail-on-missing'
does not mention what kind of files are being tested for existance.
According to Parameterized Trigger Plugin settings, 'fail-on-missing'
checks if files which are set in 'property-file' option exist.

Story: 2000448

Change-Id: I408838a7b02e602a3da09add7f322204d2106eea
This commit is contained in:
Anton Tcitlionok 2015-12-21 10:27:52 +03:00
parent ca8fb6af2f
commit 3dc6474525
1 changed files with 3 additions and 1 deletions

View File

@ -306,7 +306,9 @@ def trigger_parameterized_builds(parser, xml_parent, data):
'UNSTABLE_OR_WORSE', 'FAILED', 'ALWAYS'. (default: 'ALWAYS')
:arg str property-file: Use properties from file (optional)
:arg bool fail-on-missing: Blocks the triggering of the downstream jobs
if any of the files are not found in the workspace (default 'False')
if any of the property files are not found in the workspace.
Only valid when 'property-file' is specified.
(default 'False')
:arg bool use-matrix-child-files: Use files in workspaces of child
builds (default 'False')
:arg str matrix-child-combination-filter: A Groovy expression to filter