Skip to content

Commit 6778358

Browse files
committed
doc: expand input documentation for flux job taskmap
Problem: The documentation of `flux job taskmap` in flux-job(1) does not note that the command can also take input in raw format. Add this input type to the list described in the documentation of the `--to` option. Also correct one typo on the following line.
1 parent 9014f8c commit 6778358

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

doc/man1/flux-job.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -349,9 +349,12 @@ support task mapping formats:
349349
.. option:: --to=raw|pmi|multiline
350350

351351
Convert the taskmap to *raw* or *pmi* formats (described in RFC 34), or
352-
*multiline* which prints the node ID of each task, one per line.
352+
*multiline* which prints the node ID of each task, one per line. The
353+
default behavior is to print the RFC 34 taskmap. This option can be useful
354+
to convert between mapping forms, since :program:`flux job taskmap` can
355+
take a raw, pmi, or RFC 34 task map on the command line.
353356

354-
One one of the above options may be used per call.
357+
Only one of the above options may be used per call.
355358

356359
timeleft
357360
--------

0 commit comments

Comments
 (0)