Skip to content

Commit 3893eaf

Browse files
committed
doc: add note about --time-limit default units
Problem: The documentation of the --time-limit option in the flux-mini(1) man page doesn't note that the default unit for this option is minutes. Add a note that the default unit is minutes for the --time-limit option only.
1 parent cc53a52 commit 3893eaf

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/man1/flux-mini.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -150,11 +150,12 @@ Additional job options
150150
The **run**, **submit**, **batch**, and **alloc** commands also take
151151
following additional job parameters:
152152

153-
**-t, --time-limit=FSD**
154-
Set a time limit for the job in Flux standard duration (RFC 23).
155-
FSD is a floating point number with a single character units suffix
156-
("s", "m", "h", or "d"). If unspecified, the job is subject to the
157-
system default time limit.
153+
**-t, --time-limit=MINUTES|FSD**
154+
Set a time limit for the job in either minutes or Flux standard duration
155+
(RFC 23). FSD is a floating point number with a single character units
156+
suffix ("s", "m", "h", or "d"). The default unit for the ``--time-limit``
157+
option is minutes when no units are otherwise specified. If the time
158+
limit is unspecified, the job is subject to the system default time limit.
158159

159160
STANDARD I/O
160161
============

0 commit comments

Comments
 (0)