diff --git a/docs/man-openmpi/man3/MPIRUN-ONLY.rst b/docs/man-openmpi/man3/MPIRUN-ONLY.rst new file mode 100644 index 00000000000..67b7bee63bf --- /dev/null +++ b/docs/man-openmpi/man3/MPIRUN-ONLY.rst @@ -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). diff --git a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst index ab49e6e4ddc..d91e86e8ef1 100644 --- a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst @@ -38,6 +38,8 @@ through a call to :ref:`MPI_Open_port` on the root. ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst index 42fd705d5de..6051a70fdc3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst @@ -45,6 +45,8 @@ address of the server. It must be the same as the name returned by ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst index ab162857b4f..e0d58544fdd 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_from_group.3.rst @@ -58,6 +58,8 @@ shall have a value of at least 63. ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Comm_join.3.rst b/docs/man-openmpi/man3/MPI_Comm_join.3.rst index 736f9a97e9f..e7455f82313 100644 --- a/docs/man-openmpi/man3/MPI_Comm_join.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_join.3.rst @@ -56,6 +56,8 @@ mechanisms. ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst index 246d7278738..1d4aad15b42 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst @@ -226,6 +226,8 @@ intercommunicator can be used immediately). ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst b/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst index d06662442f0..ceb263d39cc 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst @@ -221,6 +221,8 @@ of calling :ref:`MPI_Comm_spawn` several times. ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst index 774daa97de6..c017ac30d1e 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_create_from_groups.3.rst @@ -62,6 +62,8 @@ shall have a value of at least 63. ERRORS ------ +.. include:: ./MPIRUN-ONLY.rst + .. include:: ./ERRORS.rst .. seealso:: :ref:`MPI_Comm_create_from_group` diff --git a/docs/tuning-apps/fault-tolerance/supported.rst b/docs/tuning-apps/fault-tolerance/supported.rst index 90c393eddfa..6db05bf7c7f 100644 --- a/docs/tuning-apps/fault-tolerance/supported.rst +++ b/docs/tuning-apps/fault-tolerance/supported.rst @@ -11,6 +11,11 @@ provided support for a wide range of resilience techniques: migrating from FT-MPI); :ref:`see its documentation section `. + Note that FT functionality only works properly when the MPI job + is launched via :ref:`man1-mpirun`. Using the FT functionality + in other run-time environments is currently unsupported, and may + result in undefined behavior (e.g., the MPI job may hang). + * Only for research / non-production usage * Message logging techniques. Similar to those implemented in