Skip to content

Commit

Permalink
doc: document --exclusive option in flux-mini(1)
Browse files Browse the repository at this point in the history
Problem: The flux-mini(1) --exclusive option is not documented in
the man page.

Add documentation for the --exclusive option. Also mention that the
exclusive option will default to true when --nodes is used without
--ntasks or --nslots.
  • Loading branch information
grondo committed Mar 29, 2022
1 parent 4cbb80c commit fb84e0b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions doc/man1/flux-mini.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ as a parallel job, while **batch** and **alloc** submit a script or launch
a command as the initial program of a new Flux instance.

If *--ntasks* is unspecified, a value of *N=1* is assumed. Commands that
take *--nslots* have no default and require that *--nslots* be explicitly
specified.
take *--nslots* have no default and require that *--nslots* or *--nodes*
be specified.

The **submit** and **batch** commands enqueue the job and print its numerical
Job ID on standard output.
Expand Down Expand Up @@ -98,6 +98,13 @@ following additional job parameters:
than there are tasks. If unspecified, the number of nodes will be chosen
by the scheduler.

**--exclusive**
Indicate to the scheduler that nodes should be exclusively allocated to
this job. It is an error to specify this option without also using
*-N, --nodes*. If *--nodes* is specified without *--nslots* or *--ntasks*,
then this option will be enabled by default and the number of tasks
or slots will be set to the number of requested nodes.

**-t, --time-limit=FSD**
Set a time limit for the job in Flux standard duration (RFC 23).
FSD is a floating point number with a single character units suffix
Expand Down

0 comments on commit fb84e0b

Please sign in to comment.