Add support for waiting for other jobs by name

[fio.git] / HOWTO

diff --git a/HOWTO b/HOWTO
index 482d69651c0362c3afd5863512dc32f7d73f3733..7c24c1b74296aa33cdff97eca9458defd291b6ca 100644 (file)
--- 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
                job.
 
+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.