Skip to content

Commit 1bda50e

Browse files
committed
doc: document --dependency=singleton
Problem: The singleton dependency scheme is not documented. Document it.
1 parent eac7276 commit 1bda50e

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

doc/man1/common/job-dependencies.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,14 @@ afterexcept:JOBID
5555
and a fatal job exception caused the transition to CLEANUP (e.g.,
5656
node failure, timeout, cancel, etc.).
5757

58+
singleton
59+
This dependency is satisfied when there are no other active jobs
60+
of the same userid and job name which are not already held with
61+
a singleton dependency. That is, a singleton can be the only
62+
job with the same userid and job name in the SCHED state or later.
63+
The singleton scheme requires an explicit job name using the
64+
``--job-name`` option.
65+
5866
begin-time:TIMESTAMP
5967
This dependency is satisfied after TIMESTAMP, which is specified in
6068
floating point seconds since the UNIX epoch. See the ``--begin-time``

0 commit comments

Comments
 (0)