Skip to content

docs: some functions (currently) require mpirun #12992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
+21 −0
Draft

docs: some functions (currently) require mpirun #12992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/man-openmpi/man3/MPIRUN-ONLY.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
.. admonition:: Important
:class: error

In Open MPI, this function only works properly when the MPI job is
launched via :ref:`man1-mpirun`. Using this function in other
run-time environments is currently unsupported, and may result in
undefined behavior (e.g., the MPI job may hang).
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Comm_accept.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,8 @@ through a call to :ref:`MPI_Open_port` on the root.
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso::
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Comm_connect.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ address of the server. It must be the same as the name returned by
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso::
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,8 @@ shall have a value of at least 63.
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso::
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Comm_join.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,8 @@ mechanisms.
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso::
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Comm_spawn.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -272,6 +272,8 @@ intercommunicator can be used immediately).
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso::
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,8 @@ of calling :ref:`MPI_Comm_spawn` several times.
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso::
Expand Down
2 changes: 2 additions & 0 deletions docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ shall have a value of at least 63.
ERRORS
------

.. include:: ./MPIRUN-ONLY.rst

.. include:: ./ERRORS.rst

.. seealso:: :ref:`MPI_Comm_create_from_group`
Loading