Skip to content

Commit 3bb21c0

Browse files
committed
doc: update description of --tasks-per-core in flux-mini(1)
Problem: A lack of exposition on the --tasks-per-core option of flux-mini may lead users astray in thinking this option is more useful than it really is. Move the --tasks-per-core option to the end of the Per-resource options list, thereby showing it as the lesser sibling of this option group. Expand the option description to include the many caveats, warnings, and a final note that most likely this is not the option you want.
1 parent ccc6777 commit 3bb21c0

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

doc/man1/flux-mini.rst

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -116,12 +116,17 @@ listed above:
116116
**--tasks-per-node=N**
117117
Set the number of tasks per node to run.
118118

119-
**--tasks-per-core=N**
120-
Force a number of tasks per core.
121-
122119
**--gpus-per-node=N**
123120
With -N, --nodes, request a specific number of GPUs per node.
124121

122+
**--tasks-per-core=N**
123+
Force a number of tasks per core. Note that this will run *N* tasks per
124+
*allocated* core. If nodes are exclusively scheduled by configuration or
125+
use of the ``--exclusive`` flag, then this option could result in many
126+
more tasks than expected. The default for this option is effectively 1,
127+
so it is useful only for oversubscribing tasks to cores for testing
128+
purposes. You probably don't want to use this option.
129+
125130
Batch job options
126131
-----------------
127132

0 commit comments

Comments
 (0)