Skip to content

Commit f31c26b

Browse files
committed
doc: document job shell hostfile taskmap scheme
Problem: The hostfile taskmap scheme is not documented. Mention this scheme in flux-shell(1) along with the other builtin taskmap schemes, and document it in the cli submission commands.
1 parent 4b0dc31 commit f31c26b

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

doc/man1/common/job-other-run.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@
1717
the job shell, so this option is not useful unless the total number
1818
of nodes and tasks per node are known at job submission time.
1919

20+
hostfile:FILE
21+
Assign tasks in order to hosts as they appear in FILE. FILE should
22+
have one or more lines each of which contains a host name or RFC
23+
29 Hostlist string. Each host assigned to the job must appear in
24+
the hostfile and be assigned the same number of tasks as the default
25+
taskmap from the shell. If there are less hosts in the hostfile than
26+
tasks in the job, then the list of hosts will be reused.
27+
2028
However, shell plugins may provide other task mapping schemes, so
2129
check the current job shell configuration for a full list of supported
2230
taskmap schemes.

doc/man1/flux-shell.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -126,13 +126,13 @@ topics:
126126
**taskmap.SCHEME**
127127
Called when a taskmap scheme *SCHEME* is requested via the taskmap
128128
shell option or corresponding :option:`flux submit --taskmap` option.
129-
Plugins that want to offer a different taskmap scheme than the defaults of
130-
``block``, ``cyclic``, and ``manual`` can register a ``taskmap.*`` plugin
131-
callback and then users can request this mapping with the appropriate
132-
:option:`flux submit --taskmap=name`` option. The default block taskmap is
133-
passed to the plugin as "taskmap" in the plugin input arguments, and the
134-
plugin should return the new taskmap as a string in the output args. This
135-
callback is called before ``shell.init``.
129+
Plugins that want to offer a different taskmap scheme than the defaults
130+
of ``block``, ``cyclic``, ``hostfile``, and ``manual`` can register a
131+
``taskmap.*`` plugin callback and then users can request this mapping
132+
with the appropriate :option:`flux submit --taskmap=name`` option.
133+
The default block taskmap is passed to the plugin as "taskmap" in the
134+
plugin input arguments, and the plugin should return the new taskmap as a
135+
string in the output args. This callback is called before ``shell.init``.
136136

137137
**shell.connect**
138138
Called just after the shell connects to the local Flux broker. (Only

0 commit comments

Comments
 (0)