Skip to content

Commit 4d45a5e

Browse files
committed
docs: fix outdated descriptions of -output-filename
see open-mpi#7095
1 parent 0edb311 commit 4d45a5e

File tree

2 files changed

+9
-12
lines changed

2 files changed

+9
-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: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -361,17 +361,14 @@ For rankfiles:
361361

362362
To manage standard I/O:
363363

364-
* ``--output-filename <filename>``: Redirect the stdout, stderr, and
365-
stddiag of all processes to a process-unique version of the
366-
specified filename. Any directories in the filename will
367-
automatically be created. Each output file will consist of
368-
``filename.id``, where the ``id`` will be the processes' rank in
369-
MPI_COMM_WORLD, left-filled with zero's for correct ordering in
370-
listings. A relative path value will be converted to an absolute
371-
path based on the cwd where mpirun is executed. Note that this will
372-
not work on environments where the file system on compute nodes
373-
differs from that where :ref:`mpirun(1) <man1-mpirun>` is
374-
executed.
364+
* ``--output-filename <filename>``: Redirect output from application processes
365+
into `{filename}/{job}/rank.{rank}/std[out,err,diag]`, where `{rank}` is the
366+
processes' rank in MPI_COMM_WORLD, left-filled with zero's for correct
367+
ordering in listings. Any directories in the filename will automatically be
368+
created. A relative path value will be converted to an absolute path based on
369+
the cwd where mpirun is executed. Note that this will not work on
370+
environments where the file system on compute nodes differs from that where
371+
:ref:`mpirun(1) <man1-mpirun>` is executed.
375372

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

0 commit comments

Comments
 (0)