path: root/HOWTO
diff options
Diffstat (limited to 'HOWTO')
1 files changed, 10 insertions, 0 deletions
diff --git a/HOWTO b/HOWTO
index 482d6965..7c24c1b7 100644
--- a/HOWTO
+++ b/HOWTO
@@ -305,6 +305,16 @@ name=str ASCII name of the job. This may be used to override the
special purpose of also signaling the start of a new
+wait_for=str Specifies the name of the already defined job to wait
+ for. Single waitee name only may be specified. If set, the job
+ won't be started until all workers of the waitee job are done.
+ Wait_for operates on the job name basis, so there are a few
+ limitations. First, the waitee must be defined prior to the
+ waiter job (meaning no forward references). Second, if a job
+ is being referenced as a waitee, it must have a unique name
+ (no duplicate waitees).
description=str Text description of the job. Doesn't do anything except
dump this text description when this job is run. It's
not parsed.