Skip to content

Commit efd5fba

Browse files
committed
docs: fix outdated descriptions of -output-filename
see #7095 Signed-off-by: Eisuke Kawashima <e-kwsm@users.noreply.github.com>
1 parent 37d7dc9 commit efd5fba

File tree

2 files changed

+13
-12
lines changed

2 files changed

+13
-12
lines changed

contrib/completion/mpirun.zsh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ _mpirun() {
179179
'(-N -npernode --npernode -npersocket --npersocket)'{-N,-npernode,--npernode}'[Launch n processes per node on all allocated nodes]:npernode:_guard "[[\:digit\:]]#" "number"' \
180180
'(-npernode --npernode -npersocket --npersocket)'{-npersocket,--npersocket}'[Launch n processes per socket on all allocated nodes]:npersocket:_guard "[[\:digit\:]]#" "number"' \
181181
'(-ompi-server --ompi-server)'{-ompi-server,--ompi-server}'[Specify the URI of the Open MPI server, or the name of the file (specified as file:filename) that contains that info]:server uri:' \
182-
'(-output-filename --output-filename)'{-output-filename,--output-filename}'[Redirect output from application processes into filename.rank]:filename:' \
182+
'(-output-filename --output-filename)'{-output-filename,--output-filename}'[Redirect output from application processes into files under filename]:filename:' \
183183
'(-output-proctable --output-proctable)'{-output-proctable,--output-proctable}'[Output the debugger proctable after launch]' \
184184
'(-oversubscribe --oversubscribe -nooversubscribe --nooversubscribe)'{-oversubscribe,--oversubscribe}'[Nodes are allowed to be oversubscribed, even on a managed system]' \
185185
'(-path --path)'{-path,--path}'[PATH to be used to look for executables to start processes]:path:_files -/' \

docs/man-openmpi/man1/mpirun.1.rst

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -363,17 +363,18 @@ For rankfiles:
363363

364364
To manage standard I/O:
365365

366-
* ``--output-filename <filename>``: Redirect the stdout, stderr, and
367-
stddiag of all processes to a process-unique version of the
368-
specified filename. Any directories in the filename will
369-
automatically be created. Each output file will consist of
370-
``filename.id``, where the ``id`` will be the processes' rank in
371-
MPI_COMM_WORLD, left-filled with zero's for correct ordering in
372-
listings. A relative path value will be converted to an absolute
373-
path based on the cwd where mpirun is executed. Note that this will
374-
not work on environments where the file system on compute nodes
375-
differs from that where :ref:`mpirun(1) <man1-mpirun>` is
376-
executed.
366+
* ``--output-filename <filename>``: Redirect output from application processes
367+
into ``{filename}.prterun-{hostname}-{pid}@{jobid}.{rank}.(out|err|diag)``,
368+
where ``{hostname}`` is the hostname, ``{pid}`` is the process ID of
369+
``mpirun``, ``{jobid}`` is the local job ID, and ``{rank}`` is the processes'
370+
rank in ``MPI_COMM_WORLD``, left-filled with zero's for correct ordering in
371+
file listings. A file is not created if the corresponding stream is empty.
372+
Any intermediate directories in the resulting output files will automatically
373+
be created if necessary. If ``filename`` is a relative path, it will be
374+
converted to an absolute path based on the directory where :ref:`mpirun(1)
375+
<man1-mpirun>` is executed. Note that this will not work in environments
376+
where the file system on compute nodes differs from that where
377+
:ref:`mpirun(1) <man1-mpirun>` is executed.
377378

378379
* ``--stdin <rank>``: The MPI_COMM_WORLD rank of the process that is
379380
to receive stdin. The default is to forward stdin to MPI_COMM_WORLD

0 commit comments

Comments
 (0)