diff --git a/docs/building-apps/abi-compatibility.rst b/docs/building-apps/abi-compatibility.rst index 50fbf621b5e..ab9272241bd 100644 --- a/docs/building-apps/abi-compatibility.rst +++ b/docs/building-apps/abi-compatibility.rst @@ -8,7 +8,7 @@ compatibility for the C MPI bindings to the last major Open MPI release. Specifi application compiled with Open MPI v4.x can be executed with Open MPI |ompi_series| without having to recompile the application. -.. important:: ABI is maintained for *most* of the Fortran MPI bindings, too -- see below for additional information. +.. important:: ABI is maintained for *most* of the Fortran MPI bindings, too |mdash| see below for additional information. There are however a few scenarios where an application compiled with Open MPI v4.x might not execute correctly with Open MPI 5.0. diff --git a/docs/developers/prerequisites.rst b/docs/developers/prerequisites.rst index bcca4b1b9ef..02d609cedd7 100644 --- a/docs/developers/prerequisites.rst +++ b/docs/developers/prerequisites.rst @@ -96,8 +96,8 @@ generate both the HTML version of the documentation (that you are reading right now) and the nroff man pages. Official Open MPI distribution tarballs contain pre-built HTML -documentation and man pages. This means that -- similar to the GNU -Autotools -- end users do not need to have Sphinx installed, but will +documentation and man pages. This means that |mdash| similar to the GNU +Autotools |mdash| end users do not need to have Sphinx installed, but will still have both the HTML documentation and man pages installed as part of the normal configure / build / install process. diff --git a/docs/developers/rst-for-markdown-expats.rst b/docs/developers/rst-for-markdown-expats.rst index ec99ac9c292..af09f7dee33 100644 --- a/docs/developers/rst-for-markdown-expats.rst +++ b/docs/developers/rst-for-markdown-expats.rst @@ -228,7 +228,7 @@ Comments will not be included in the rendered output. Your comment can even include blank lines. You terminate a - comment -- just like most other things in RST -- by a blank + comment |mdash| just like most other things in RST |mdash| by a blank line and then outdenting back out to the same column as the first ".". diff --git a/docs/developers/source-code.rst b/docs/developers/source-code.rst index 134dc95d14c..118d053a933 100644 --- a/docs/developers/source-code.rst +++ b/docs/developers/source-code.rst @@ -54,7 +54,7 @@ C / C++ * C99-style mixing declarations are allow allowable (and preferred). * **ALWAYS** include ``_config.h`` as your first #include file, - where ```` is one of ``ompi``, ``oshmem``, or ``opal`` -- the + where ```` is one of ``ompi``, ``oshmem``, or ``opal`` |mdash| the level that you're writing in. There are very, very few cases where this is not true (E.g., some bizarre Windows scenarios). But in 99.9999% of cases, this file should be included **first** so that it @@ -77,7 +77,7 @@ C / C++ * The GNU Way is to ``#define`` a macro when it is "true" and to ``#undef`` it when it is "false". * In Open MPI, we **always** ``#define`` a logical macro to be - either 0 or 1 -- we never ``#undef`` it. + either 0 or 1 |mdash| we never ``#undef`` it. * The reason for this is defensive programming: if you are only checking if a preprocessor macro is defined (via ``#ifdef FOO`` or ``#if defined(FOO)``), you will get no warning when compiling if diff --git a/docs/features/java.rst b/docs/features/java.rst index cd8cc9d68be..81fedd72bb7 100644 --- a/docs/features/java.rst +++ b/docs/features/java.rst @@ -6,7 +6,7 @@ Open MPI Java bindings Open MPI |ompi_ver| provides support for Java-based MPI applications. .. warning:: The Open MPI Java bindings are provided on a - "provisional" basis -- i.e., they are not part of the current or + "provisional" basis |mdash| i.e., they are not part of the current or proposed MPI standards. Thus, inclusion of Java support is not required by the standard. Continued inclusion of the Java bindings is contingent upon active user interest and continued developer diff --git a/docs/features/ulfm.rst b/docs/features/ulfm.rst index 5660468137a..86815b7e435 100644 --- a/docs/features/ulfm.rst +++ b/docs/features/ulfm.rst @@ -573,7 +573,7 @@ sign up on the user's mailing list: ulfm+subscribe@googlegroups.com Because of spam, only subscribers are allowed to post to these lists (ensure that you subscribe with and post from exactly the same e-mail -address -- joe@example.com is considered different than +address |mdash| joe@example.com is considered different than joe@mycomputer.example.com!). Visit these pages to subscribe to the lists: https://groups.google.com/forum/#!forum/ulfm diff --git a/docs/history.rst b/docs/history.rst index b701acd7803..8cb1c38eb3d 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -20,13 +20,13 @@ MPI implementation focused on different areas of excellence, we all shared the same common core values: * A full MPI implementation -* Production quality code -- it has to "just work" +* Production quality code |mdash| it has to "just work" * A desire to explore lots of things that an MPI implementation can do that we've never had the time/resources to investigate because we are bound to bug fixing, etc. Hence, we decided to collaborate and pool our resources. At SC2003, -we decided to start an entire new code base -- leaving all the cruft +we decided to start an entire new code base |mdash| leaving all the cruft and legacy code of our prior implementations behind. Take the best, leave the rest. The source tree's first commit was on November 22, 2003; development work started in earnest on January 5, 2004. Since diff --git a/docs/installing-open-mpi/configure-cli-options/installation.rst b/docs/installing-open-mpi/configure-cli-options/installation.rst index 783a6236bc7..cce5ec6e632 100644 --- a/docs/installing-open-mpi/configure-cli-options/installation.rst +++ b/docs/installing-open-mpi/configure-cli-options/installation.rst @@ -238,7 +238,7 @@ be used with ``configure``: Some examples: #. Default to building all components as static (i.e., as part of - the Open MPI core libraries -- no DSOs):: + the Open MPI core libraries |mdash| no DSOs):: shell$ ./configure @@ -304,7 +304,7 @@ be used with ``configure``: their Open MPI package, both of which require support libraries (``libFOO.so`` and ``libBAR.so``). If an end user only has BAR hardware, they likely only have ``libBAR.so`` available on their - systems -- not ``libFOO.so``. Disabling load errors by default will + systems |mdash| not ``libFOO.so``. Disabling load errors by default will prevent the user from seeing potentially confusing warnings about the FOO components failing to load because ``libFOO.so`` is not available on their systems. diff --git a/docs/installing-open-mpi/configure-cli-options/misc.rst b/docs/installing-open-mpi/configure-cli-options/misc.rst index bdce34c99ac..489608a63e4 100644 --- a/docs/installing-open-mpi/configure-cli-options/misc.rst +++ b/docs/installing-open-mpi/configure-cli-options/misc.rst @@ -29,7 +29,7 @@ above categories that can be used with ``configure``: with different endian representations). Heterogeneous support is disabled by default because it imposes a minor performance penalty. - .. danger:: The heterogeneous functionality is currently broken -- + .. danger:: The heterogeneous functionality is currently broken |mdash| do not use. .. _install-wrapper-flags-label: @@ -40,7 +40,7 @@ above categories that can be used with ``configure``: * ``--with-wrapper-ldflags=LDFLAGS`` * ``--with-wrapper-libs=LIBS``: Add the specified flags to the default flags that are used in Open - MPI's "wrapper" compilers (e.g., ``mpicc`` -- see below for more + MPI's "wrapper" compilers (e.g., ``mpicc`` |mdash| see below for more information about Open MPI's wrapper compilers). By default, Open MPI's wrapper compilers use the same compilers used to build Open MPI and specify a minimum set of additional flags that are necessary diff --git a/docs/installing-open-mpi/configure-cli-options/runtime.rst b/docs/installing-open-mpi/configure-cli-options/runtime.rst index eea1cbc9227..c6e825e63d7 100644 --- a/docs/installing-open-mpi/configure-cli-options/runtime.rst +++ b/docs/installing-open-mpi/configure-cli-options/runtime.rst @@ -13,7 +13,7 @@ can be used with ``configure``: prevents most ``rsh``/``ssh``-based users from needing to modify their shell startup files to set the ``PATH`` and/or ``LD_LIBRARY_PATH`` for Open MPI on remote nodes. Note, however, that such users may still - desire to set ``PATH`` -- perhaps even in their shell startup files -- + desire to set ``PATH`` |mdash| perhaps even in their shell startup files |mdash| so that executables such as ``mpicc`` and ``mpirun`` can be found without needing to type long path names. diff --git a/docs/installing-open-mpi/required-support-libraries.rst b/docs/installing-open-mpi/required-support-libraries.rst index f88a7987fc1..69c8f802d34 100644 --- a/docs/installing-open-mpi/required-support-libraries.rst +++ b/docs/installing-open-mpi/required-support-libraries.rst @@ -339,7 +339,7 @@ script deciding the following: * The Fortran compiler is ``gfortran`` (which is the Homebrew-installed Fortran compiler). * There is a suitable system-installed hwloc in ``/usr/local``, which - can be found -- by the C compiler/linker -- without specifying any + can be found |mdash| by the C compiler/linker |mdash| without specifying any additional linker search paths. The careful reader will realize that the C and Fortran compilers are @@ -354,8 +354,8 @@ library search paths are different: Hence, since the majority of Open MPI's source code base is in C, it compiles/links against hwloc successfully. But when Open MPI's Fortran code for the ``mpi_f08`` module is compiled and linked, the -Homebrew-installed ``gfortran`` -- which does not search -``/usr/local/lib`` by default -- cannot find ``libhwloc``, and the link +Homebrew-installed ``gfortran`` |mdash| which does not search +``/usr/local/lib`` by default |mdash| cannot find ``libhwloc``, and the link fails. There are a few different possible solutions to this issue: diff --git a/docs/installing-open-mpi/supported-systems.rst b/docs/installing-open-mpi/supported-systems.rst index 45b4c6d6e81..e2ccff6853f 100644 --- a/docs/installing-open-mpi/supported-systems.rst +++ b/docs/installing-open-mpi/supported-systems.rst @@ -59,7 +59,7 @@ interconnects at the time of its release. This, unfortunately, does mean that Open MPI removes support for networks that are no longer commonly-used in HPC environments. If you still have one of these older interconnects, not all new version of -Open MPI may support your interconnect -- sorry! This simply reflects +Open MPI may support your interconnect |mdash| sorry! This simply reflects the reality of limited development, testing, and maintenance resources. diff --git a/docs/launching-apps/scheduling.rst b/docs/launching-apps/scheduling.rst index 1edea0a85df..b39e99bdde8 100644 --- a/docs/launching-apps/scheduling.rst +++ b/docs/launching-apps/scheduling.rst @@ -96,7 +96,7 @@ while there are still processes to be scheduled, Open MPI will trigger an oversubscription condition. If ``:OVERSUBSCRIBE`` is added as a modifier to the ``--map-by`` -option (e.g., ``mpirun --map-by node:OVERSUBSCRIBE ...`` -- :ref:`see +option (e.g., ``mpirun --map-by node:OVERSUBSCRIBE ...`` |mdash| :ref:`see this section ` for more details), Open MPI will continue to loop through the list of nodes again and try to schedule one more process to each node until all diff --git a/docs/launching-apps/troubleshooting.rst b/docs/launching-apps/troubleshooting.rst index c7a6fe85b8f..e5ed1618a48 100644 --- a/docs/launching-apps/troubleshooting.rst +++ b/docs/launching-apps/troubleshooting.rst @@ -22,7 +22,7 @@ why this can happen. .. code-block:: c - /* This is a Linux example -- the issue is similar/the same on other + /* This is a Linux example |mdash| the issue is similar/the same on other operating systems */ handle = dlopen("libmpi.so", RTLD_NOW | RTLD_LOCAL); diff --git a/docs/man-openmpi/man1/mpirun.1.rst b/docs/man-openmpi/man1/mpirun.1.rst index c9168b60076..93aac7e03f5 100644 --- a/docs/man-openmpi/man1/mpirun.1.rst +++ b/docs/man-openmpi/man1/mpirun.1.rst @@ -105,8 +105,8 @@ are slightly different than PRRTE's CLI commands. .. include:: /schizo-ompi-rst-content/schizo-ompi-cli.rstxt -OPTIONS (OLD / HARD-CODED CONTENT -- TO BE AUDITED --------------------------------------------------- +OPTIONS (OLD / HARD-CODED CONTENT |mdash| TO BE AUDITED +------------------------------------------------------- .. admonition:: This is old content :class: error @@ -1548,7 +1548,7 @@ variables. The ``--mca`` settings similarly override MCA parameters set in the ``$OPAL_PREFIX/etc/openmpi-mca-params.conf`` or ``$HOME/.openmpi/mca-params.conf`` file. -Unknown ```` arguments are still set as environment variable -- +Unknown ```` arguments are still set as environment variable |mdash| they are not checked (by mpirun) for correctness. Illegal or incorrect ```` arguments may or may not be reported |mdash| it depends on the specific MCA module. diff --git a/docs/man-openmpi/man1/ompi-wrapper-compiler.1.rst b/docs/man-openmpi/man1/ompi-wrapper-compiler.1.rst index d61ad6085b9..249de903ad2 100644 --- a/docs/man-openmpi/man1/ompi-wrapper-compiler.1.rst +++ b/docs/man-openmpi/man1/ompi-wrapper-compiler.1.rst @@ -137,7 +137,7 @@ link MPI applications that use any/all of the MPI Fortran bindings: Open MPI was installed with support for each of these Fortran bindings). Specifically: it is no longer necessary to use different wrapper compilers for applications that use ``mpif.h`` -vs. applications that use the ``mpi`` module -- just use ``mpifort`` +vs. applications that use the ``mpi`` module |mdash| just use ``mpifort`` for all Fortran MPI applications. Note, however, that the Fortran compiler may require additional diff --git a/docs/man-openmpi/man1/ompi_info.1.rst b/docs/man-openmpi/man1/ompi_info.1.rst index 8b3e11c5761..0699ae5b7d8 100644 --- a/docs/man-openmpi/man1/ompi_info.1.rst +++ b/docs/man-openmpi/man1/ompi_info.1.rst @@ -123,7 +123,7 @@ The three categories are: used to tweak MPI application performance. This even includes parameters that control resource exhaustion levels (e.g., number of free list entries, size of buffers, etc.), and could be considered - "correctness" parameters if they're set too low. But, really -- + "correctness" parameters if they're set too low. But, really |mdash| they're tuning parameters. #. **Open MPI developer**: Parameters in this category either don't @@ -133,7 +133,7 @@ The three categories are: And within each category, there are three sub-categories: #. **Basic**: This sub-category is for parameters that everyone in - this category will want to see -- even less-advanced end users, + this category will want to see |mdash| even less-advanced end users, application tuners, and new OMPI developers. #. **Detailed**: This sub-category is for parameters that are diff --git a/docs/man-openmpi/man3/MPI_Abort.3.rst b/docs/man-openmpi/man3/MPI_Abort.3.rst index 935d6ade789..7a7f08c515d 100644 --- a/docs/man-openmpi/man3/MPI_Abort.3.rst +++ b/docs/man-openmpi/man3/MPI_Abort.3.rst @@ -6,7 +6,7 @@ MPI_Abort .. include_body -:ref:`MPI_Abort` - Terminates MPI execution environment. +:ref:`MPI_Abort` |mdash| Terminates MPI execution environment. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Add_error_class.3.rst b/docs/man-openmpi/man3/MPI_Add_error_class.3.rst index 2cf968cdbb5..98c7f8006b0 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_class.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_class.3.rst @@ -6,7 +6,7 @@ MPI_Add_error_class .. include_body -:ref:`MPI_Add_error_class` - Creates a new error class and returns its value +:ref:`MPI_Add_error_class` |mdash| Creates a new error class and returns its value SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst index 146b10ce3a8..56e84f4c6c7 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst @@ -6,7 +6,7 @@ MPI_Add_error_code .. include_body -:ref:`MPI_Add_error_code` - Creates a new error code associated with +:ref:`MPI_Add_error_code` |mdash| Creates a new error code associated with *errorclass* diff --git a/docs/man-openmpi/man3/MPI_Add_error_string.3.rst b/docs/man-openmpi/man3/MPI_Add_error_string.3.rst index 9cda1ac884f..4aedbe72ce2 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_string.3.rst @@ -6,7 +6,7 @@ MPI_Add_error_string .. include_body -:ref:`MPI_Add_error_string` - Associates a string with an error code or class +:ref:`MPI_Add_error_string` |mdash| Associates a string with an error code or class SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Address.3.rst b/docs/man-openmpi/man3/MPI_Address.3.rst index 69e9427d8cb..03620f8dcb4 100644 --- a/docs/man-openmpi/man3/MPI_Address.3.rst +++ b/docs/man-openmpi/man3/MPI_Address.3.rst @@ -6,7 +6,7 @@ MPI_Address .. include_body -:ref:`MPI_Address` - Gets the address of a location in memory -- |deprecated_favor| :ref:`MPI_Get_address`. +:ref:`MPI_Address` |mdash| Gets the address of a location in memory |mdash| |deprecated_favor| :ref:`MPI_Get_address`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst index f64f153b3c2..22d6e31fd89 100644 --- a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst +++ b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst @@ -6,7 +6,7 @@ MPI_Alloc_mem .. include_body -:ref:`MPI_Alloc_mem` - Allocates a specified memory segment. +:ref:`MPI_Alloc_mem` |mdash| Allocates a specified memory segment. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst index f1f311c23a6..6c37e43f75f 100644 --- a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst @@ -6,7 +6,7 @@ MPI_Attr_delete .. include_body -:ref:`MPI_Attr_delete` - Deletes attribute value associated with a key -- |deprecated_favor| :ref:`MPI_Comm_delete_attr`. +:ref:`MPI_Attr_delete` |mdash| Deletes attribute value associated with a key |mdash| |deprecated_favor| :ref:`MPI_Comm_delete_attr`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Attr_get.3.rst b/docs/man-openmpi/man3/MPI_Attr_get.3.rst index 1a9a69e3e05..196a131eb42 100644 --- a/docs/man-openmpi/man3/MPI_Attr_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_get.3.rst @@ -6,7 +6,7 @@ MPI_Attr_get .. include_body -:ref:`MPI_Attr_get` - Retrieves attribute value by key -- |deprecated_favor| :ref:`MPI_Comm_get_attr`. +:ref:`MPI_Attr_get` |mdash| Retrieves attribute value by key |mdash| |deprecated_favor| :ref:`MPI_Comm_get_attr`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Attr_put.3.rst b/docs/man-openmpi/man3/MPI_Attr_put.3.rst index b922b88b7e4..7f3f7cfbd51 100644 --- a/docs/man-openmpi/man3/MPI_Attr_put.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_put.3.rst @@ -6,7 +6,7 @@ MPI_Attr_put .. include_body -:ref:`MPI_Attr_put` - Stores attribute value associated with a key -- |deprecated_favor| :ref:`MPI_Comm_set_attr`. +:ref:`MPI_Attr_put` |mdash| Stores attribute value associated with a key |mdash| |deprecated_favor| :ref:`MPI_Comm_set_attr`. diff --git a/docs/man-openmpi/man3/MPI_Bsend.3.rst b/docs/man-openmpi/man3/MPI_Bsend.3.rst index 1cb3bc1272f..95db7730c44 100644 --- a/docs/man-openmpi/man3/MPI_Bsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Bsend.3.rst @@ -5,7 +5,7 @@ MPI_Bsend .. include_body -:ref:`MPI_Bsend` - Basic send with user-specified buffering. +:ref:`MPI_Bsend` |mdash| Basic send with user-specified buffering. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Bsend_init.3.rst b/docs/man-openmpi/man3/MPI_Bsend_init.3.rst index 60229f23912..8a4dca9416d 100644 --- a/docs/man-openmpi/man3/MPI_Bsend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Bsend_init.3.rst @@ -5,7 +5,7 @@ MPI_Bsend_init .. include_body -:ref:`MPI_Bsend_init` - Builds a handle for a buffered send. +:ref:`MPI_Bsend_init` |mdash| Builds a handle for a buffered send. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst index deb7aced560..a58edd4075a 100644 --- a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst +++ b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst @@ -5,7 +5,7 @@ MPI_Buffer_attach .. include_body -:ref:`MPI_Buffer_attach` - Attaches a user-defined buffer for sending. +:ref:`MPI_Buffer_attach` |mdash| Attaches a user-defined buffer for sending. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst index 49afe2438c7..f1e55d77609 100644 --- a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst +++ b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst @@ -5,7 +5,7 @@ MPI_Buffer_detach .. include_body -:ref:`MPI_Buffer_detach` - Removes an existing buffer (for use in in :ref:`MPI_Bsend`, +:ref:`MPI_Buffer_detach` |mdash| Removes an existing buffer (for use in in :ref:`MPI_Bsend`, etc.) SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cancel.3.rst b/docs/man-openmpi/man3/MPI_Cancel.3.rst index 2c5bcdebf9c..3668f21c33b 100644 --- a/docs/man-openmpi/man3/MPI_Cancel.3.rst +++ b/docs/man-openmpi/man3/MPI_Cancel.3.rst @@ -5,7 +5,7 @@ MPI_Cancel .. include_body -:ref:`MPI_Cancel` - Cancels a communication request. +:ref:`MPI_Cancel` |mdash| Cancels a communication request. SYNTAX ------ @@ -74,7 +74,7 @@ loop for a canceled communication, then :ref:`MPI_Test` will eventually be successful. :ref:`MPI_Cancel` can be used to cancel a communication that uses a persistent -request (see Section 3.9 in the MPI-1 Standard, "Persistent +request (see Section 3.9 in the `MPI Standard `_, "Persistent Communication Requests") in the same way it is used for nonpersistent requests. A successful cancellation cancels the active communication, but not the request itself. After the call to :ref:`MPI_Cancel` and the diff --git a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst index 28045b8347f..99fa6b29589 100644 --- a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst @@ -5,7 +5,7 @@ MPI_Cart_coords .. include_body -:ref:`MPI_Cart_coords` - Determines process coords in Cartesian topology +:ref:`MPI_Cart_coords` |mdash| Determines process coords in Cartesian topology given rank in group. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cart_create.3.rst b/docs/man-openmpi/man3/MPI_Cart_create.3.rst index a25dbd9fb47..72fb6304f87 100644 --- a/docs/man-openmpi/man3/MPI_Cart_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_create.3.rst @@ -5,7 +5,7 @@ MPI_Cart_create .. include_body -:ref:`MPI_Cart_create` - Makes a new communicator to which Cartesian +:ref:`MPI_Cart_create` |mdash| Makes a new communicator to which Cartesian topology information has been attached. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cart_get.3.rst b/docs/man-openmpi/man3/MPI_Cart_get.3.rst index 72d66ec4f02..3c6f5f192b5 100644 --- a/docs/man-openmpi/man3/MPI_Cart_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_get.3.rst @@ -5,7 +5,7 @@ MPI_Cart_get .. include_body -:ref:`MPI_Cart_get` - Retrieves Cartesian topology information associated with +:ref:`MPI_Cart_get` |mdash| Retrieves Cartesian topology information associated with a communicator. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cart_map.3.rst b/docs/man-openmpi/man3/MPI_Cart_map.3.rst index 432175f7d91..a665604273d 100644 --- a/docs/man-openmpi/man3/MPI_Cart_map.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_map.3.rst @@ -5,7 +5,7 @@ MPI_Cart_map .. include_body -:ref:`MPI_Cart_map` - Maps process to Cartesian topology information. +:ref:`MPI_Cart_map` |mdash| Maps process to Cartesian topology information. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst index 4e7d23eebf4..f05f530cde2 100644 --- a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst @@ -5,7 +5,7 @@ MPI_Cart_rank .. include_body -:ref:`MPI_Cart_rank` - Determines process rank in communicator given Cartesian +:ref:`MPI_Cart_rank` |mdash| Determines process rank in communicator given Cartesian location. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cart_shift.3.rst b/docs/man-openmpi/man3/MPI_Cart_shift.3.rst index df57c581927..463e9b5e624 100644 --- a/docs/man-openmpi/man3/MPI_Cart_shift.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_shift.3.rst @@ -5,7 +5,7 @@ MPI_Cart_shift .. include_body -:ref:`MPI_Cart_shift` - Returns the shifted source and destination ranks, +:ref:`MPI_Cart_shift` |mdash| Returns the shifted source and destination ranks, given a shift direction and amount. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cart_sub.3.rst b/docs/man-openmpi/man3/MPI_Cart_sub.3.rst index 2f01057bfdb..ae869b864e2 100644 --- a/docs/man-openmpi/man3/MPI_Cart_sub.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_sub.3.rst @@ -5,7 +5,7 @@ MPI_Cart_sub .. include_body -:ref:`MPI_Cart_sub` - Partitions a communicator into subgroups, which form +:ref:`MPI_Cart_sub` |mdash| Partitions a communicator into subgroups, which form lower-dimensional Cartesian subgrids. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst b/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst index e519466a3f7..f13454dc1dc 100644 --- a/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst @@ -5,7 +5,7 @@ MPI_Cartdim_get .. include_body -:ref:`MPI_Cartdim_get` - Retrieves Cartesian topology information associated +:ref:`MPI_Cartdim_get` |mdash| Retrieves Cartesian topology information associated with a communicator. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Close_port.3.rst b/docs/man-openmpi/man3/MPI_Close_port.3.rst index 12c7bb9caf7..5e038cc5513 100644 --- a/docs/man-openmpi/man3/MPI_Close_port.3.rst +++ b/docs/man-openmpi/man3/MPI_Close_port.3.rst @@ -5,7 +5,7 @@ MPI_Close_port .. include_body -:ref:`MPI_Close_port` - Releases the specified network address. +:ref:`MPI_Close_port` |mdash| Releases the specified network address. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst index ec5012e3ff5..566bac06f94 100644 --- a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst @@ -5,7 +5,7 @@ MPI_Comm_accept .. include_body -:ref:`MPI_Comm_accept` - Establishes communication with a client. +:ref:`MPI_Comm_accept` |mdash| Establishes communication with a client. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst index eb0cb0a11b5..d6ec63e92be 100644 --- a/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst @@ -5,7 +5,7 @@ MPI_Comm_call_errhandler .. include_body -:ref:`MPI_Comm_call_errhandler` - Passes the supplied error code to the error +:ref:`MPI_Comm_call_errhandler` |mdash| Passes the supplied error code to the error handler assigned to a communicator SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_compare.3.rst b/docs/man-openmpi/man3/MPI_Comm_compare.3.rst index f0c151bfefe..a2f6e8a505e 100644 --- a/docs/man-openmpi/man3/MPI_Comm_compare.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_compare.3.rst @@ -5,7 +5,7 @@ MPI_Comm_compare .. include_body -:ref:`MPI_Comm_compare` - Compares two communicators. +:ref:`MPI_Comm_compare` |mdash| Compares two communicators. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst index 916636ba1d3..0957d4a848e 100644 --- a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst @@ -5,7 +5,7 @@ MPI_Comm_connect .. include_body -:ref:`MPI_Comm_connect` - Establishes communication with a server. +:ref:`MPI_Comm_connect` |mdash| Establishes communication with a server. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Comm_create.3.rst b/docs/man-openmpi/man3/MPI_Comm_create.3.rst index 7e30b25277b..f94f587074c 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create.3.rst @@ -5,7 +5,7 @@ MPI_Comm_create .. include_body -:ref:`MPI_Comm_create` - Creates a new communicator. +:ref:`MPI_Comm_create` |mdash| Creates a new communicator. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst index 2993cc7e5a3..162a49b68a0 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst @@ -5,7 +5,7 @@ MPI_Comm_create_errhandler .. include_body -:ref:`MPI_Comm_create_errhandler` - Creates an error handler that can be +:ref:`MPI_Comm_create_errhandler` |mdash| Creates an error handler that can be attached to communicators. SYNTAX 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 e060ec06107..12afb779f5c 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 @@ -5,7 +5,7 @@ MPI_Comm_create_from_group .. include_body -:ref:`MPI_Comm_create_from_group` - Creates a new communicator from a group and +:ref:`MPI_Comm_create_from_group` |mdash| Creates a new communicator from a group and stringtag SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst index 4830f73409d..ed70846a739 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst @@ -5,7 +5,7 @@ MPI_Comm_create_group .. include_body -:ref:`MPI_Comm_create_group` - Creates a new communicator. +:ref:`MPI_Comm_create_group` |mdash| Creates a new communicator. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst b/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst index 78075605a57..2758fe94e29 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst @@ -5,7 +5,7 @@ MPI_Comm_create_keyval .. include_body -:ref:`MPI_Comm_create_keyval` - Generates a new attribute key. +:ref:`MPI_Comm_create_keyval` |mdash| Generates a new attribute key. SYNTAX ------ @@ -75,13 +75,13 @@ deprecated. The C binding is identical. The Fortran binding differs in that ``extra_state`` is an address-sized integer. Also, the copy and delete callback functions have Fortran bindings that are consistent with address-sized attributes. The argument ``comm_copy_attr_fn`` may be -specified as MPI_COMM_NULL_COPY_FN or MPI_COMM_DUP_FN from C or -Fortran. MPI_COMM_NULL_COPY_FN is a function that does nothing more -than returning ``flag = 0`` and MPI_SUCCESS. MPI_COMM_DUP_FN is +specified as ``MPI_COMM_NULL_COPY_FN`` or ``MPI_COMM_DUP_FN`` from C or +Fortran. ``MPI_COMM_NULL_COPY_FN`` is a function that does nothing more +than returning ``flag = 0`` and ``MPI_SUCCESS``. ``MPI_COMM_DUP_FN`` is a simple-minded copy function that sets ``flag = 1``, returns the value of ``attribute_val_in`` in ``attribute_val_out``, and returns -MPI_SUCCESS. These replace the MPI-1 predefined callbacks -MPI_NULL_COPY_FN and MPI_DUP_FN, the use of which is deprecated. +``MPI_SUCCESS``. These replace the MPI-1 predefined callbacks +``MPI_NULL_COPY_FN`` and ``MPI_DUP_FN``, the use of which is deprecated. The two C callback functions are: .. code-block:: c diff --git a/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst b/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst index 15fc4bf3524..60465b18067 100644 --- a/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst @@ -5,7 +5,7 @@ MPI_Comm_delete_attr .. include_body -:ref:`MPI_Comm_delete_attr` - Deletes attribute value associated with a +:ref:`MPI_Comm_delete_attr` |mdash| Deletes attribute value associated with a key. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst b/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst index b7f3f793073..70ad12f89ec 100644 --- a/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst @@ -5,7 +5,7 @@ MPI_Comm_disconnect .. include_body -:ref:`MPI_Comm_disconnect` - Deallocates communicator object and sets handle to +:ref:`MPI_Comm_disconnect` |mdash| Deallocates communicator object and sets handle to MPI_COMM_NULL. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_dup.3.rst b/docs/man-openmpi/man3/MPI_Comm_dup.3.rst index cf8de2c6663..6ebbd905080 100644 --- a/docs/man-openmpi/man3/MPI_Comm_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_dup.3.rst @@ -5,7 +5,7 @@ MPI_Comm_dup .. include_body -:ref:`MPI_Comm_dup` - Duplicates an existing communicator with all its cached +:ref:`MPI_Comm_dup` |mdash| Duplicates an existing communicator with all its cached information. SYNTAX @@ -63,7 +63,10 @@ determines the attribute value associated with this key in the new communicator; one particular action that a copy callback may take is to delete the attribute from the new communicator. Returns in newcomm a new communicator with the same group, any copied cached information, but a -new context (see Section 5.7.1 of the MPI-1 Standard, "Functionality"). +new context (see the "Functionality" subsection of the "Caching" +section in the "Groups, Contexts, and Communicators" chapter in the +`MPI Standard `_). + NOTES ----- @@ -71,7 +74,8 @@ NOTES This operation is used to provide a parallel library call with a duplicate communication space that has the same properties as the original communicator. This includes any attributes (see below) and -topologies (see Chapter 6, "Process Topologies," in the MPI-1 Standard). +topologies (see the "Process Topologies" chapter in the `MPI Standard +`_). This call is valid even if there are pending point-to-point communications involving the communicator comm. A typical call might involve an :ref:`MPI_Comm_dup` at the beginning of the parallel call, and an diff --git a/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst index 816dd0e2a9b..cc262cd9391 100644 --- a/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_dup_with_info.3.rst @@ -5,7 +5,7 @@ MPI_Comm_dup_with_info .. include_body -:ref:`MPI_Comm_dup_with_info` - Duplicates an existing communicator using +:ref:`MPI_Comm_dup_with_info` |mdash| Duplicates an existing communicator using provided info. SYNTAX @@ -71,7 +71,8 @@ NOTES This operation is used to provide a parallel library call with a duplicate communication space that has the same properties as the original communicator. This includes any attributes (see below) and -topologies (see Chapter 6, "Process Topologies," in the MPI-1 Standard). +topologies (see the "Process Topologies" chapter in the `MPI Standard +`_. This call is valid even if there are pending point-to-point communications involving the communicator comm. A typical call might involve an :ref:`MPI_Comm_dup_with_info` at the beginning of the parallel call, diff --git a/docs/man-openmpi/man3/MPI_Comm_free.3.rst b/docs/man-openmpi/man3/MPI_Comm_free.3.rst index acafe33d8e2..9a220b7fec9 100644 --- a/docs/man-openmpi/man3/MPI_Comm_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_free.3.rst @@ -6,7 +6,7 @@ MPI_Comm_free .. include_body -:ref:`MPI_Comm_free` - Mark a communicator object for deallocation. +:ref:`MPI_Comm_free` |mdash| Mark a communicator object for deallocation. SYNTAX @@ -61,8 +61,10 @@ handle is set to MPI_COMM_NULL. Any pending operations that use this communicator will complete normally; the object is actually deallocated only if there are no other active references to it. This call applies to intracommunicators and intercommunicators. Upon actual deallocation, the -delete callback functions for all cached attributes (see Section 5.7 in -the MPI-1 Standard, "Caching") are called in arbitrary order. +delete callback functions for all cached attributes (see the "Caching" +section in the "Groups, Contexts, and Communicators" chapter in the +`MPI Standard `_) are called in +arbitrary order. NOTES diff --git a/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst b/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst index aa64c72c035..1301201d462 100644 --- a/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst @@ -6,7 +6,7 @@ MPI_Comm_free_keyval .. include_body -:ref:`MPI_Comm_free_keyval` - Frees attribute key for communicator cache +:ref:`MPI_Comm_free_keyval` |mdash| Frees attribute key for communicator cache attribute. diff --git a/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst index 6f35f8f993c..d2f3ce8bcf6 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst @@ -6,7 +6,7 @@ MPI_Comm_get_attr .. include_body -:ref:`MPI_Comm_get_attr` - Retrieves attribute value by key. +:ref:`MPI_Comm_get_attr` |mdash| Retrieves attribute value by key. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst index d821fa93d46..f5acdbbf7d6 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Comm_get_errhandler .. include_body -:ref:`MPI_Comm_get_errhandler` - Retrieves error handler associated with a +:ref:`MPI_Comm_get_errhandler` |mdash| Retrieves error handler associated with a communicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst index 7770f43a88f..d560834449c 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst @@ -6,7 +6,7 @@ MPI_Comm_get_info .. include_body -:ref:`MPI_Comm_get_info` - Retrieves active communicator info hints +:ref:`MPI_Comm_get_info` |mdash| Retrieves active communicator info hints SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst index e8632b595b9..43547cdb397 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst @@ -6,7 +6,7 @@ MPI_Comm_get_name .. include_body -:ref:`MPI_Comm_get_name` - Returns the name that was most recently +:ref:`MPI_Comm_get_name` |mdash| Returns the name that was most recently associated with a communicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst b/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst index 8bd230f5c21..92f20cba93e 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst @@ -6,7 +6,7 @@ MPI_Comm_get_parent .. include_body -:ref:`MPI_Comm_get_parent` - Returns the parent intercommunicator of +:ref:`MPI_Comm_get_parent` |mdash| Returns the parent intercommunicator of current spawned process. diff --git a/docs/man-openmpi/man3/MPI_Comm_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_group.3.rst index 479084dfd46..d0a0f9ce431 100644 --- a/docs/man-openmpi/man3/MPI_Comm_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_group.3.rst @@ -6,7 +6,7 @@ MPI_Comm_group .. include_body -:ref:`MPI_Comm_group` - Returns the group associated with a communicator. +:ref:`MPI_Comm_group` |mdash| Returns the group associated with a communicator. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_idup.3.rst b/docs/man-openmpi/man3/MPI_Comm_idup.3.rst index 7218ca6058d..df4909dc5a0 100644 --- a/docs/man-openmpi/man3/MPI_Comm_idup.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_idup.3.rst @@ -6,7 +6,7 @@ MPI_Comm_idup .. include_body -:ref:`MPI_Comm_idup` - Start the nonblocking duplication of an existing +:ref:`MPI_Comm_idup` |mdash| Start the nonblocking duplication of an existing communicator with all its cached information. @@ -67,8 +67,10 @@ respective copy callback function determines the attribute value associated with this key in the new communicator; one particular action that a copy callback may take is to delete the attribute from the new communicator. Returns in newcomm a new communicator with the same group, -any copied cached information, but a new context (see Section 5.7.1 of -the MPI-1 Standard, "Functionality"). The communicator returned in +any copied cached information, but a new context (see the +"Functionality" subsection of the "Caching" section in the "Groups, +Contexts, and Communicators" chapter in the `MPI Standard +`_). The communicator returned in *newcomm* will not be available until the request is complete. The completion of a communicator duplication request can be determined @@ -82,7 +84,8 @@ NOTES This operation is used to provide a parallel library call with a duplicate communication space that has the same properties as the original communicator. This includes any attributes (see below) and -topologies (see Chapter 6, "Process Topologies," in the MPI-1 Standard). +topologies (see the "Process Topologies" chapter in the `MPI Standard +`_). This call is valid even if there are pending point-to-point communications involving the communicator comm. A typical call might involve an :ref:`MPI_Comm_idup` at the beginning of the parallel call, and an diff --git a/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst index 0bc58bb336b..1681d18defd 100644 --- a/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_idup_with_info.3.rst @@ -6,7 +6,7 @@ MPI_Comm_idup_with_info .. include_body -:ref:`MPI_Comm_idup_with_info` - Start the nonblocking duplication of an +:ref:`MPI_Comm_idup_with_info` |mdash| Start the nonblocking duplication of an existing communicator with all its cached information. @@ -68,8 +68,10 @@ value, the respective copy callback function determines the attribute value associated with this key in the new communicator; one particular action that a copy callback may take is to delete the attribute from the new communicator. Returns in newcomm a new communicator with the same -group, any copied cached information, but a new context (see Section -5.7.1 of the MPI-1 Standard, "Functionality"). The communicator returned +group, any copied cached information, but a new context +(see the "Functionality" subsection of the "Caching" +section in the "Groups, Contexts, and Communicators" chapter in the +`MPI Standard `_). The communicator returned in *newcomm* will not be available until the request is complete. The hints provided by the supplied *info* argument are associated with the output communicator. @@ -85,7 +87,8 @@ NOTES This operation is used to provide a parallel library call with a duplicate communication space that has the same properties as the original communicator. This includes any attributes (see below) and -topologies (see Chapter 6, "Process Topologies," in the MPI-1 Standard). +topologies (see the "Process Topologies" chapter in the `MPI Standard +`_). This call is valid even if there are pending point-to-point communications involving the communicator comm. A typical call might involve an :ref:`MPI_Comm_idup_with_info` at the beginning of the parallel diff --git a/docs/man-openmpi/man3/MPI_Comm_join.3.rst b/docs/man-openmpi/man3/MPI_Comm_join.3.rst index eba7aaf2612..5da538e88a3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_join.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_join.3.rst @@ -6,7 +6,7 @@ MPI_Comm_join .. include_body -:ref:`MPI_Comm_join` - Establishes communication between MPI jobs +:ref:`MPI_Comm_join` |mdash| Establishes communication between MPI jobs SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_rank.3.rst b/docs/man-openmpi/man3/MPI_Comm_rank.3.rst index 10e496bd7b1..12d813fbb1a 100644 --- a/docs/man-openmpi/man3/MPI_Comm_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_rank.3.rst @@ -6,7 +6,7 @@ MPI_Comm_rank .. include_body -:ref:`MPI_Comm_rank` - Determines the rank of the calling process in the +:ref:`MPI_Comm_rank` |mdash| Determines the rank of the calling process in the communicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst index 1bf52c2083a..37b985c90ce 100644 --- a/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst @@ -6,7 +6,7 @@ MPI_Comm_remote_group .. include_body -:ref:`MPI_Comm_remote_group` - Accesses the remote group associated with an +:ref:`MPI_Comm_remote_group` |mdash| Accesses the remote group associated with an intercommunicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst b/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst index 5a770098ca9..30472af7918 100644 --- a/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst @@ -6,7 +6,7 @@ MPI_Comm_remote_size .. include_body -:ref:`MPI_Comm_remote_size` - Determines the size of the remote group +:ref:`MPI_Comm_remote_size` |mdash| Determines the size of the remote group associated with an intercommunicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst index c2c9339ad65..e1d91e01202 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst @@ -6,7 +6,7 @@ MPI_Comm_set_attr .. include_body -:ref:`MPI_Comm_set_attr` - Stores attribute value associated with a key. +:ref:`MPI_Comm_set_attr` |mdash| Stores attribute value associated with a key. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst index 3a4fa8707a4..70ff4de912f 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Comm_set_errhandler .. include_body -:ref:`MPI_Comm_set_errhandler` - Attaches a new error handler to a +:ref:`MPI_Comm_set_errhandler` |mdash| Attaches a new error handler to a communicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst index 23d9069e0ac..fc0f7e706f0 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst @@ -6,7 +6,7 @@ MPI_Comm_set_info .. include_body -:ref:`MPI_Comm_set_info` - Set communicator info hints +:ref:`MPI_Comm_set_info` |mdash| Set communicator info hints SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst b/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst index d5bc5f61294..090f57ddc89 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst @@ -6,7 +6,7 @@ MPI_Comm_set_name .. include_body -:ref:`MPI_Comm_set_name` - Associates a name with a communicator. +:ref:`MPI_Comm_set_name` |mdash| Associates a name with a communicator. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_size.3.rst b/docs/man-openmpi/man3/MPI_Comm_size.3.rst index 4d9d7f40e76..673a1a45ec4 100644 --- a/docs/man-openmpi/man3/MPI_Comm_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_size.3.rst @@ -6,7 +6,7 @@ MPI_Comm_size .. include_body -:ref:`MPI_Comm_size` - Returns the size of the group associated with a +:ref:`MPI_Comm_size` |mdash| Returns the size of the group associated with a communicator. diff --git a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst index af5468d0473..006eef9e5e1 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst @@ -6,7 +6,7 @@ MPI_Comm_spawn .. include_body -:ref:`MPI_Comm_spawn` - Spawns a number of identical binaries. +:ref:`MPI_Comm_spawn` |mdash| Spawns a number of identical binaries. SYNTAX 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 192b870a027..43a253f29e1 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst @@ -6,7 +6,7 @@ MPI_Comm_spawn_multiple .. include_body -:ref:`MPI_Comm_spawn_multiple` - Spawns multiple binaries, or the same +:ref:`MPI_Comm_spawn_multiple` |mdash| Spawns multiple binaries, or the same binary with multiple sets of arguments. @@ -63,7 +63,7 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``count``: Number of commands (positive integer, significant to MPI only at *root* -- see NOTES). +* ``count``: Number of commands (positive integer, significant to MPI only at *root* |mdash| see NOTES). * ``array_of_commands``: Programs to be executed (array of strings, significant only at *root*). * ``array_of_argv``: Arguments for *commands* (array of array of strings, significant only at *root*). * ``array_of_maxprocs``: Maximum number of processes to start for each command (array of integers, significant only at *root*). diff --git a/docs/man-openmpi/man3/MPI_Comm_split.3.rst b/docs/man-openmpi/man3/MPI_Comm_split.3.rst index 40fcbdd05d6..19150ee2698 100644 --- a/docs/man-openmpi/man3/MPI_Comm_split.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_split.3.rst @@ -6,7 +6,7 @@ MPI_Comm_split .. include_body -:ref:`MPI_Comm_split` - Creates new communicators based on colors and keys. +:ref:`MPI_Comm_split` |mdash| Creates new communicators based on colors and keys. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst b/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst index 96bd7208633..618dceb7616 100644 --- a/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst @@ -6,7 +6,7 @@ MPI_Comm_split_type .. include_body -:ref:`MPI_Comm_split_type` - Creates new communicators based on colors and +:ref:`MPI_Comm_split_type` |mdash| Creates new communicators based on colors and keys. diff --git a/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst b/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst index ba519c3db73..b1441b424ca 100644 --- a/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst @@ -6,7 +6,7 @@ MPI_Comm_test_inter .. include_body -:ref:`MPI_Comm_test_inter` - Tests to see if a comm is an +:ref:`MPI_Comm_test_inter` |mdash| Tests to see if a comm is an intercommunicator. diff --git a/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst b/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst index b47c0e5132e..ead9f2990bb 100644 --- a/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst +++ b/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst @@ -6,7 +6,7 @@ MPI_Compare_and_swap .. include_body -:ref:`MPI_Compare_and_swap` - Perform RMA compare-and-swap +:ref:`MPI_Compare_and_swap` |mdash| Perform RMA compare-and-swap SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Dims_create.3.rst b/docs/man-openmpi/man3/MPI_Dims_create.3.rst index 7174e4551d0..fe64b2b9498 100644 --- a/docs/man-openmpi/man3/MPI_Dims_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Dims_create.3.rst @@ -6,7 +6,7 @@ MPI_Dims_create .. include_body -:ref:`MPI_Dims_create` - Creates a division of processors in a Cartesian +:ref:`MPI_Dims_create` |mdash| Creates a division of processors in a Cartesian grid. diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst index 6905d42097d..0fb420c9dc7 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst @@ -6,7 +6,7 @@ MPI_Dist_graph_create .. include_body -:ref:`MPI_Dist_graph_create` - Makes a new communicator to which topology +:ref:`MPI_Dist_graph_create` |mdash| Makes a new communicator to which topology information has been attached. diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst index 62b8ae8b856..a472981da7a 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_create_adjacent.3.rst @@ -6,7 +6,7 @@ MPI_Dist_graph_create_adjacent .. include_body -:ref:`MPI_Dist_graph_create_adjacent` - Makes a new communicator to which +:ref:`MPI_Dist_graph_create_adjacent` |mdash| Makes a new communicator to which topology information has been attached. diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst index 9c4822bf89a..7f8bd7d4514 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst @@ -6,7 +6,7 @@ MPI_Dist_graph_neighbors .. include_body -:ref:`MPI_Dist_graph_neighbors` - Returns the neighbors of the calling +:ref:`MPI_Dist_graph_neighbors` |mdash| Returns the neighbors of the calling process in a distributed graph topology. diff --git a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst index 9814b38af43..914affd59b4 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors_count.3.rst @@ -6,7 +6,7 @@ MPI_Dist_graph_neighbors_count .. include_body -:ref:`MPI_Dist_graph_neighbors_count` - Returns the number of in and out +:ref:`MPI_Dist_graph_neighbors_count` |mdash| Returns the number of in and out edges for the calling processes in a distributed graph topology and a flag indicating whether the distributed graph is weighted. diff --git a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst index b49516769d0..68a9093ac56 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst @@ -6,7 +6,7 @@ MPI_Errhandler_create .. include_body -:ref:`MPI_Errhandler_create` - Creates an MPI-style error handler -- |deprecated_favor| :ref:`MPI_Comm_create_errhandler`. +:ref:`MPI_Errhandler_create` |mdash| Creates an MPI-style error handler |mdash| |deprecated_favor| :ref:`MPI_Comm_create_errhandler`. @@ -78,10 +78,11 @@ may be written in Fortran. NOTE ---- -The MPI-1 Standard states that an implementation may make the output +The `MPI Standard `_ states that an +implementation may make the output value (errhandler) simply the address of the function. However, the action of :ref:`MPI_Errhandler_free` makes this impossible, since it is -required to set the value of the argument to MPI_ERRHANDLER_NULL. In +required to set the value of the argument to ``MPI_ERRHANDLER_NULL``. In addition, the actual error handler must remain until all communicators that use it are freed. diff --git a/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst index 7ca75555adb..a3c952e8468 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst @@ -6,7 +6,7 @@ MPI_Errhandler_free .. include_body -:ref:`MPI_Errhandler_free` - Frees an MPI-style error handler. +:ref:`MPI_Errhandler_free` |mdash| Frees an MPI-style error handler. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst index d6294c86986..5591ad7981a 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst @@ -6,7 +6,7 @@ MPI_Errhandler_get .. include_body -:ref:`MPI_Errhandler_get` - Gets the error handler for a communicator -- |deprecated_favor| :ref:`MPI_Comm_get_errhandler`. +:ref:`MPI_Errhandler_get` |mdash| Gets the error handler for a communicator |mdash| |deprecated_favor| :ref:`MPI_Comm_get_errhandler`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst index dc216d880a4..2cfcbafe784 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst @@ -6,7 +6,7 @@ MPI_Errhandler_set .. include_body -:ref:`MPI_Errhandler_set` - Sets the error handler for a communicator -- |deprecated_favor| :ref:`MPI_Comm_set_errhandler`. +:ref:`MPI_Errhandler_set` |mdash| Sets the error handler for a communicator |mdash| |deprecated_favor| :ref:`MPI_Comm_set_errhandler`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Error_class.3.rst b/docs/man-openmpi/man3/MPI_Error_class.3.rst index 05c6d1aa320..911eab27a88 100644 --- a/docs/man-openmpi/man3/MPI_Error_class.3.rst +++ b/docs/man-openmpi/man3/MPI_Error_class.3.rst @@ -6,7 +6,7 @@ MPI_Error_class .. include_body -:ref:`MPI_Error_class` - Converts an error code into an error class. +:ref:`MPI_Error_class` |mdash| Converts an error code into an error class. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Error_string.3.rst b/docs/man-openmpi/man3/MPI_Error_string.3.rst index 69822afd205..12a223afe76 100644 --- a/docs/man-openmpi/man3/MPI_Error_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Error_string.3.rst @@ -6,7 +6,7 @@ MPI_Error_string .. include_body -:ref:`MPI_Error_string` - Returns a string for a given error code. +:ref:`MPI_Error_string` |mdash| Returns a string for a given error code. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst b/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst index f8e03a51ac7..f905a3fcf79 100644 --- a/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst +++ b/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst @@ -6,7 +6,7 @@ MPI_Fetch_and_op .. include_body -:ref:`MPI_Fetch_and_op` - Combines the contents of the origin buffer with +:ref:`MPI_Fetch_and_op` |mdash| Combines the contents of the origin buffer with that of a target buffer and returns the target buffer value. diff --git a/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst index f013b33149f..b61d14a54b9 100644 --- a/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_File_call_errhandler .. include_body -:ref:`MPI_File_call_errhandler` - Passes the supplied error code to the +:ref:`MPI_File_call_errhandler` |mdash| Passes the supplied error code to the error handler assigned to a file diff --git a/docs/man-openmpi/man3/MPI_File_close.3.rst b/docs/man-openmpi/man3/MPI_File_close.3.rst index a0b4da30e6c..b03ea578eaf 100644 --- a/docs/man-openmpi/man3/MPI_File_close.3.rst +++ b/docs/man-openmpi/man3/MPI_File_close.3.rst @@ -6,7 +6,7 @@ MPI_File_close .. include_body -:ref:`MPI_File_close` - Closes a file (collective). +:ref:`MPI_File_close` |mdash| Closes a file (collective). SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst index 76abdb15e41..f82455af5bd 100644 --- a/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_File_create_errhandler .. include_body -:ref:`MPI_File_create_errhandler` - Creates an MPI-style error handler that +:ref:`MPI_File_create_errhandler` |mdash| Creates an MPI-style error handler that can be attached to a file. diff --git a/docs/man-openmpi/man3/MPI_File_delete.3.rst b/docs/man-openmpi/man3/MPI_File_delete.3.rst index 465d1944397..1d4fdbf0632 100644 --- a/docs/man-openmpi/man3/MPI_File_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_File_delete.3.rst @@ -6,7 +6,7 @@ MPI_File_delete .. include_body -:ref:`MPI_File_delete` - Deletes a file. +:ref:`MPI_File_delete` |mdash| Deletes a file. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_get_amode.3.rst b/docs/man-openmpi/man3/MPI_File_get_amode.3.rst index 32dd0ae5672..9c53743983b 100644 --- a/docs/man-openmpi/man3/MPI_File_get_amode.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_amode.3.rst @@ -6,7 +6,7 @@ MPI_File_get_amode .. include_body -:ref:`MPI_File_get_amode` - Returns access mode associated with an open +:ref:`MPI_File_get_amode` |mdash| Returns access mode associated with an open file. diff --git a/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst b/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst index 1d1107a4bf8..2af33ae1c62 100644 --- a/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst @@ -6,7 +6,7 @@ MPI_File_get_atomicity .. include_body -:ref:`MPI_File_get_atomicity` - Returns current consistency semantics for +:ref:`MPI_File_get_atomicity` |mdash| Returns current consistency semantics for data-access operations. diff --git a/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst b/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst index 20e424aa2ba..6b5a548c6fa 100644 --- a/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_byte_offset.3.rst @@ -6,7 +6,7 @@ MPI_File_get_byte_offset .. include_body -:ref:`MPI_File_get_byte_offset` - Converts a view-relative offset into an +:ref:`MPI_File_get_byte_offset` |mdash| Converts a view-relative offset into an absolute byte position. diff --git a/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst index fc5c2082f36..eb27953541e 100644 --- a/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_File_get_errhandler .. include_body -:ref:`MPI_File_get_errhandler` - Gets the error handler for a file. +:ref:`MPI_File_get_errhandler` |mdash| Gets the error handler for a file. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_get_group.3.rst b/docs/man-openmpi/man3/MPI_File_get_group.3.rst index de575c7ced5..67163d4b21c 100644 --- a/docs/man-openmpi/man3/MPI_File_get_group.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_group.3.rst @@ -6,7 +6,7 @@ MPI_File_get_group .. include_body -:ref:`MPI_File_get_group` - Returns a duplicate of the process group of a +:ref:`MPI_File_get_group` |mdash| Returns a duplicate of the process group of a file. diff --git a/docs/man-openmpi/man3/MPI_File_get_info.3.rst b/docs/man-openmpi/man3/MPI_File_get_info.3.rst index b77a8b1501d..5cb2ebc55bc 100644 --- a/docs/man-openmpi/man3/MPI_File_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_info.3.rst @@ -6,7 +6,7 @@ MPI_File_get_info .. include_body -:ref:`MPI_File_get_info` - Returns a new info object containing values for +:ref:`MPI_File_get_info` |mdash| Returns a new info object containing values for current hints associated with a file. diff --git a/docs/man-openmpi/man3/MPI_File_get_position.3.rst b/docs/man-openmpi/man3/MPI_File_get_position.3.rst index 5fc36141a4b..b018d05fbbc 100644 --- a/docs/man-openmpi/man3/MPI_File_get_position.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_position.3.rst @@ -6,7 +6,7 @@ MPI_File_get_position .. include_body -:ref:`MPI_File_get_position` - Returns the current position of the +:ref:`MPI_File_get_position` |mdash| Returns the current position of the individual file pointer. diff --git a/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst b/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst index 06c1e841ad8..a916469912c 100644 --- a/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_position_shared.3.rst @@ -6,7 +6,7 @@ MPI_File_get_position_shared .. include_body -:ref:`MPI_File_get_position_shared` - Returns the current position of the +:ref:`MPI_File_get_position_shared` |mdash| Returns the current position of the shared file pointer. diff --git a/docs/man-openmpi/man3/MPI_File_get_size.3.rst b/docs/man-openmpi/man3/MPI_File_get_size.3.rst index 7f94f67cdad..06bfb42acbc 100644 --- a/docs/man-openmpi/man3/MPI_File_get_size.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_size.3.rst @@ -6,7 +6,7 @@ MPI_File_get_size .. include_body -:ref:`MPI_File_get_size` - Returns the current size of the file. +:ref:`MPI_File_get_size` |mdash| Returns the current size of the file. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst b/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst index d9b6d4691e2..b2b7db3a7c0 100644 --- a/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_type_extent.3.rst @@ -6,7 +6,7 @@ MPI_File_get_type_extent .. include_body -:ref:`MPI_File_get_type_extent` - Returns the extent of the data type in a +:ref:`MPI_File_get_type_extent` |mdash| Returns the extent of the data type in a file. diff --git a/docs/man-openmpi/man3/MPI_File_get_view.3.rst b/docs/man-openmpi/man3/MPI_File_get_view.3.rst index c7bb3e49eec..654986801dc 100644 --- a/docs/man-openmpi/man3/MPI_File_get_view.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_view.3.rst @@ -6,7 +6,7 @@ MPI_File_get_view .. include_body -:ref:`MPI_File_get_view` - Returns the process's view of data in the file. +:ref:`MPI_File_get_view` |mdash| Returns the process's view of data in the file. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_iread.3.rst b/docs/man-openmpi/man3/MPI_File_iread.3.rst index 5eaec9729f1..fe0e26cc168 100644 --- a/docs/man-openmpi/man3/MPI_File_iread.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread.3.rst @@ -6,7 +6,7 @@ MPI_File_iread .. include_body -:ref:`MPI_File_iread` - Reads a file starting at the location specified by +:ref:`MPI_File_iread` |mdash| Reads a file starting at the location specified by the individual file pointer (nonblocking, noncollective). @@ -78,7 +78,7 @@ pointer position maintained by the system in which a total number of buffer *buf.* The data is taken out of those parts of the file specified by the current view. :ref:`MPI_File_iread` stores the number of data-type elements actually read in *status.* All other fields of *status* are -undefined. It is erroneous to call this function if MPI_MODE_SEQUENTIAL +undefined. It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_iread_all.3.rst b/docs/man-openmpi/man3/MPI_File_iread_all.3.rst index 5d11419154b..0ecc9a78a50 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_all.3.rst @@ -6,7 +6,7 @@ MPI_File_iread_all .. include_body -:ref:`MPI_File_iread_all` - Reads a file starting at the location specified +:ref:`MPI_File_iread_all` |mdash| Reads a file starting at the location specified by the individual file pointer (nonblocking, collective). @@ -79,7 +79,7 @@ the user's buffer *buf.* The data is taken out of those parts of the file specified by the current view. :ref:`MPI_File_iread_all` stores the number of data-type elements actually read in *status.* All other fields of *status* are undefined. It is erroneous to call this function if -MPI_MODE_SEQUENTIAL mode was specified when the file was opened. +``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. ERRORS diff --git a/docs/man-openmpi/man3/MPI_File_iread_at.3.rst b/docs/man-openmpi/man3/MPI_File_iread_at.3.rst index 16153b4dca6..b33ca8ace3a 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_at.3.rst @@ -6,7 +6,7 @@ MPI_File_iread_at .. include_body -:ref:`MPI_File_iread_at` - Reads a file at an explicitly specified offset +:ref:`MPI_File_iread_at` |mdash| Reads a file at an explicitly specified offset (nonblocking, noncollective). diff --git a/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst index 0118d724b00..cd91f7590c7 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_at_all.3.rst @@ -6,7 +6,7 @@ MPI_File_iread_at_all .. include_body -:ref:`MPI_File_iread_at_all` - Reads a file at an explicitly specified +:ref:`MPI_File_iread_at_all` |mdash| Reads a file at an explicitly specified offset (nonblocking, collective). diff --git a/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst b/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst index 8ee47828b4d..d8c8bcc1273 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst @@ -6,7 +6,7 @@ MPI_File_iread_shared .. include_body -:ref:`MPI_File_iread_shared` - Reads a file using the shared file pointer +:ref:`MPI_File_iread_shared` |mdash| Reads a file using the shared file pointer (nonblocking, noncollective). diff --git a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst index eeef229e219..9f3646eb58d 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst @@ -6,7 +6,7 @@ MPI_File_iwrite .. include_body -:ref:`MPI_File_iwrite` - Writes a file starting at the location specified +:ref:`MPI_File_iwrite` |mdash| Writes a file starting at the location specified by the individual file pointer (nonblocking, noncollective). @@ -80,7 +80,7 @@ specified by the current view. :ref:`MPI_File_iwrite` stores the number of *datatype* elements actually written in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was open. diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst index d84031c44e0..1958c9d27cb 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst @@ -6,7 +6,7 @@ MPI_File_iwrite_all .. include_body -:ref:`MPI_File_iwrite_all` - Writes a file starting at the location +:ref:`MPI_File_iwrite_all` |mdash| Writes a file starting at the location specified by the individual file pointer (nonblocking, collective). @@ -80,7 +80,7 @@ specified by the current view. :ref:`MPI_File_iwrite_all` stores the number of *datatype* elements actually written in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was open. diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst index c4cdcf8c15e..092e4ec4845 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst @@ -6,7 +6,7 @@ MPI_File_iwrite_at .. include_body -:ref:`MPI_File_iwrite_at` - Writes a file at an explicitly specified offset +:ref:`MPI_File_iwrite_at` |mdash| Writes a file at an explicitly specified offset (nonblocking, noncollective). @@ -85,7 +85,7 @@ elements actually written in *status.* All other fields of *status* are undefined. The request structure can be passed to :ref:`MPI_Wait` or :ref:`MPI_Test`, which will return a status with the number of bytes actually accessed. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was open. diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst index 5193fa40528..ee78ccc2743 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst @@ -6,7 +6,7 @@ MPI_File_iwrite_at_all .. include_body -:ref:`MPI_File_iwrite_at_all` - Writes a file at an explicitly specified +:ref:`MPI_File_iwrite_at_all` |mdash| Writes a file at an explicitly specified offset (nonblocking, collective). @@ -86,7 +86,7 @@ other fields of *status* are undefined. The request structure can be passed to :ref:`MPI_Wait` or :ref:`MPI_Test`, which will return a status with the number of bytes actually accessed. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was open. diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst index 67788a39bb6..9038a57542c 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst @@ -6,7 +6,7 @@ MPI_File_iwrite_shared .. include_body -:ref:`MPI_File_iwrite_shared` - Writes a file using the shared file pointer +:ref:`MPI_File_iwrite_shared` |mdash| Writes a file using the shared file pointer (nonblocking, noncollective). diff --git a/docs/man-openmpi/man3/MPI_File_open.3.rst b/docs/man-openmpi/man3/MPI_File_open.3.rst index d49d08334f4..b58cbe18958 100644 --- a/docs/man-openmpi/man3/MPI_File_open.3.rst +++ b/docs/man-openmpi/man3/MPI_File_open.3.rst @@ -6,7 +6,7 @@ MPI_File_open .. include_body -:ref:`MPI_File_open` - Opens a file (collective). +:ref:`MPI_File_open` |mdash| Opens a file (collective). SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst index 78d177091de..10afc862843 100644 --- a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst +++ b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst @@ -6,7 +6,7 @@ MPI_File_preallocate .. include_body -:ref:`MPI_File_preallocate` - Preallocates a specified amount of storage +:ref:`MPI_File_preallocate` |mdash| Preallocates a specified amount of storage space at the beginning of a file (collective). @@ -78,7 +78,7 @@ file size is unchanged. The treatment of file pointers, pending nonblocking accesses, and file consistency is the same as with :ref:`MPI_File_set_size`. If -MPI_MODE_SEQUENTIAL mode was specified when the file was opened, it is +``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened, it is erroneous to call this routine. diff --git a/docs/man-openmpi/man3/MPI_File_read.3.rst b/docs/man-openmpi/man3/MPI_File_read.3.rst index 976fd2dca40..f108000ea71 100644 --- a/docs/man-openmpi/man3/MPI_File_read.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read.3.rst @@ -6,7 +6,7 @@ MPI_File_read .. include_body -:ref:`MPI_File_read` - Reads a file starting at the location specified by +:ref:`MPI_File_read` |mdash| Reads a file starting at the location specified by the individual file pointer (blocking, noncollective). @@ -77,7 +77,7 @@ specified by the current view. :ref:`MPI_File_read` stores the number of data-type elements actually read in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_read_all.3.rst b/docs/man-openmpi/man3/MPI_File_read_all.3.rst index 758563227dd..f5d94eb20d6 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all.3.rst @@ -6,7 +6,7 @@ MPI_File_read_all .. include_body -:ref:`MPI_File_read_all` - Reads a file starting at the locations specified +:ref:`MPI_File_read_all` |mdash| Reads a file starting at the locations specified by individual file pointers (blocking, collective). @@ -77,7 +77,7 @@ out of those parts of the file specified by the current view. :ref:`MPI_File_read_all` stores the number of data-type elements actually read in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst index 5e27c0a2e0a..90bf7e52ef6 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst @@ -6,7 +6,7 @@ MPI_File_read_all_begin .. include_body -:ref:`MPI_File_read_all_begin` - Reads a file starting at the locations +:ref:`MPI_File_read_all_begin` |mdash| Reads a file starting at the locations specified by individual file pointers; beginning part of a split collective routine (nonblocking). @@ -82,7 +82,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst index cf3e71c6afc..1922dd71567 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst @@ -6,7 +6,7 @@ MPI_File_read_all_end .. include_body -:ref:`MPI_File_read_all_end` - Reads a file starting at the locations +:ref:`MPI_File_read_all_end` |mdash| Reads a file starting at the locations specified by individual file pointers; ending part of a split collective routine (blocking). @@ -77,7 +77,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_read_at.3.rst b/docs/man-openmpi/man3/MPI_File_read_at.3.rst index d3ed0573433..8ba1b25fea5 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at.3.rst @@ -6,7 +6,7 @@ MPI_File_read_at .. include_body -:ref:`MPI_File_read_at` - Reads a file at an explicitly specified offset +:ref:`MPI_File_read_at` |mdash| Reads a file at an explicitly specified offset (blocking, noncollective). @@ -81,7 +81,7 @@ locating an offset. The data is taken out of those parts of the file specified by the current view. :ref:`MPI_File_read_at` stores the number of *datatype* elements actually read in *status.* All other fields of *status* are undefined. It is erroneous to call this function if -MPI_MODE_SEQUENTIAL mode was specified when the file was opened. +``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. ERRORS diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst index ce58787e0da..5aeb0db1f78 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst @@ -6,7 +6,7 @@ MPI_File_read_at_all .. include_body -:ref:`MPI_File_read_at_all` - Reads a file at explicitly specified offsets +:ref:`MPI_File_read_at_all` |mdash| Reads a file at explicitly specified offsets (blocking, collective). @@ -81,7 +81,7 @@ is, holes are not counted when locating an offset. The data is taken out of those parts of the file specified by the current view. :ref:`MPI_File_read_at_all` stores the number of *datatype* elements actually read in *status.* All other fields of *status* are undefined. It is -erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst index bac7b189cb4..7b974df50d1 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at_all_begin.3.rst @@ -6,7 +6,7 @@ MPI_File_read_at_all_begin .. include_body -:ref:`MPI_File_read_at_all_begin` - Reads a file at explicitly specified +:ref:`MPI_File_read_at_all_begin` |mdash| Reads a file at explicitly specified offsets; beginning part of a split collective routine (nonblocking). diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst index 197ddccb181..338282b7423 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst @@ -6,7 +6,7 @@ MPI_File_read_at_all_end .. include_body -:ref:`MPI_File_read_at_all_end` - Reads a file at explicitly specified +:ref:`MPI_File_read_at_all_end` |mdash| Reads a file at explicitly specified offsets; ending part of a split collective routine (blocking). @@ -76,7 +76,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst index 21c0fe76526..6eeca31269c 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst @@ -6,7 +6,7 @@ MPI_File_read_ordered .. include_body -:ref:`MPI_File_read_ordered` - Reads a file at a location specified by a +:ref:`MPI_File_read_ordered` |mdash| Reads a file at a location specified by a shared file pointer (blocking, collective). diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst index d9e2a5d6f90..496f1e61bd6 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst @@ -6,7 +6,7 @@ MPI_File_read_ordered_begin .. include_body -:ref:`MPI_File_read_ordered_begin` - Reads a file at a location specified +:ref:`MPI_File_read_ordered_begin` |mdash| Reads a file at a location specified by a shared file pointer; beginning part of a split collective routine (nonblocking). @@ -86,7 +86,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst index 5143eab7573..8023ae2490e 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst @@ -6,7 +6,7 @@ MPI_File_read_ordered_end .. include_body -:ref:`MPI_File_read_ordered_end` - Reads a file at a location specified by +:ref:`MPI_File_read_ordered_end` |mdash| Reads a file at a location specified by a shared file pointer; ending part of a split collective routine (blocking). @@ -81,7 +81,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_read_shared.3.rst b/docs/man-openmpi/man3/MPI_File_read_shared.3.rst index a6e20d1c16d..d96c8e65fbd 100644 --- a/docs/man-openmpi/man3/MPI_File_read_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_shared.3.rst @@ -6,7 +6,7 @@ MPI_File_read_shared .. include_body -:ref:`MPI_File_read_shared` - Reads a file using the shared file pointer +:ref:`MPI_File_read_shared` |mdash| Reads a file using the shared file pointer (blocking, noncollective). diff --git a/docs/man-openmpi/man3/MPI_File_seek.3.rst b/docs/man-openmpi/man3/MPI_File_seek.3.rst index 4428d567b80..66186ee07b4 100644 --- a/docs/man-openmpi/man3/MPI_File_seek.3.rst +++ b/docs/man-openmpi/man3/MPI_File_seek.3.rst @@ -6,7 +6,7 @@ MPI_File_seek .. include_body -:ref:`MPI_File_seek` - Updates individual file pointers (noncollective). +:ref:`MPI_File_seek` |mdash| Updates individual file pointers (noncollective). SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst b/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst index 2f6269b0bb3..f6933fe4270 100644 --- a/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst @@ -6,7 +6,7 @@ MPI_File_seek_shared .. include_body -:ref:`MPI_File_seek_shared` - Updates the global shared file pointer +:ref:`MPI_File_seek_shared` |mdash| Updates the global shared file pointer (collective). diff --git a/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst b/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst index 8b82617e672..2ca8d704825 100644 --- a/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst @@ -6,7 +6,7 @@ MPI_File_set_atomicity .. include_body -:ref:`MPI_File_set_atomicity` - Sets consistency semantics for data-access +:ref:`MPI_File_set_atomicity` |mdash| Sets consistency semantics for data-access operations (collective). diff --git a/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst index 1591dd81c7a..aeefbfc1fbd 100644 --- a/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_File_set_errhandler .. include_body -:ref:`MPI_File_set_errhandler` - Sets the error handler for a file. +:ref:`MPI_File_set_errhandler` |mdash| Sets the error handler for a file. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_set_info.3.rst b/docs/man-openmpi/man3/MPI_File_set_info.3.rst index e24f4484cc1..d0727f8b3e3 100644 --- a/docs/man-openmpi/man3/MPI_File_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_info.3.rst @@ -6,7 +6,7 @@ MPI_File_set_info .. include_body -:ref:`MPI_File_set_info` - Sets new values for hints (collective). +:ref:`MPI_File_set_info` |mdash| Sets new values for hints (collective). SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_set_size.3.rst b/docs/man-openmpi/man3/MPI_File_set_size.3.rst index 2aebd51ca9d..7d96d6453cb 100644 --- a/docs/man-openmpi/man3/MPI_File_set_size.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_size.3.rst @@ -6,7 +6,7 @@ MPI_File_set_size .. include_body -:ref:`MPI_File_set_size` - Resizes a file (collective). +:ref:`MPI_File_set_size` |mdash| Resizes a file (collective). SYNTAX @@ -77,7 +77,7 @@ shared file pointer. Note that the actual amount of storage space cannot be allocated by :ref:`MPI_File_set_size`. Use :ref:`MPI_File_preallocate` to accomplish this. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_set_view.3.rst b/docs/man-openmpi/man3/MPI_File_set_view.3.rst index f1002e7d65d..18c0ab67cd5 100644 --- a/docs/man-openmpi/man3/MPI_File_set_view.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_view.3.rst @@ -6,7 +6,7 @@ MPI_File_set_view .. include_body -:ref:`MPI_File_set_view` - Changes process's view of data in file +:ref:`MPI_File_set_view` |mdash| Changes process's view of data in file (collective). @@ -76,7 +76,7 @@ DESCRIPTION ----------- The :ref:`MPI_File_set_view` routine changes the process's view of the data in -the file -- the beginning of the data accessible in the file through +the file |mdash| the beginning of the data accessible in the file through that view is set to *disp;* the type of data is set to *etype;* and the distribution of data to processes is set to *filetype.* In addition, :ref:`MPI_File_set_view` resets the independent file pointers and the shared diff --git a/docs/man-openmpi/man3/MPI_File_sync.3.rst b/docs/man-openmpi/man3/MPI_File_sync.3.rst index ae7a8d3d86e..225dbf432b2 100644 --- a/docs/man-openmpi/man3/MPI_File_sync.3.rst +++ b/docs/man-openmpi/man3/MPI_File_sync.3.rst @@ -6,7 +6,7 @@ MPI_File_sync .. include_body -:ref:`MPI_File_sync` - Makes semantics consistent for data-access +:ref:`MPI_File_sync` |mdash| Makes semantics consistent for data-access operations (collective). diff --git a/docs/man-openmpi/man3/MPI_File_write.3.rst b/docs/man-openmpi/man3/MPI_File_write.3.rst index 26808b87be4..bbed607bbae 100644 --- a/docs/man-openmpi/man3/MPI_File_write.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write.3.rst @@ -6,7 +6,7 @@ MPI_File_write .. include_body -:ref:`MPI_File_write` - Writes a file starting at the location specified by +:ref:`MPI_File_write` |mdash| Writes a file starting at the location specified by the individual file pointer (blocking, noncollective). @@ -81,7 +81,7 @@ specified by the current view. :ref:`MPI_File_write` stores the number of *datatype* elements actually written in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_write_all.3.rst b/docs/man-openmpi/man3/MPI_File_write_all.3.rst index 30f15d31dc1..941f61b8329 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all.3.rst @@ -6,7 +6,7 @@ MPI_File_write_all .. include_body -:ref:`MPI_File_write_all` - Writes a file starting at the locations +:ref:`MPI_File_write_all` |mdash| Writes a file starting at the locations specified by individual file pointers (blocking, collective). @@ -77,7 +77,7 @@ into those parts of the file specified by the current view. :ref:`MPI_File_write_all` stores the number of *datatype* elements actually written in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst index 1c838cd2931..eb572c77a7c 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst @@ -6,7 +6,7 @@ MPI_File_write_all_begin .. include_body -:ref:`MPI_File_write_all_begin` - Writes a file starting at the locations +:ref:`MPI_File_write_all_begin` |mdash| Writes a file starting at the locations specified by individual file pointers; beginning part of a split collective routine (nonblocking). @@ -82,7 +82,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst index 8cbf2b69166..0b4354cd43c 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst @@ -6,7 +6,7 @@ MPI_File_write_all_end .. include_body -:ref:`MPI_File_write_all_end` - Writes a file starting at the locations +:ref:`MPI_File_write_all_end` |mdash| Writes a file starting at the locations specified by individual file pointers; ending part of a split collective routine (blocking). @@ -80,7 +80,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_write_at.3.rst b/docs/man-openmpi/man3/MPI_File_write_at.3.rst index 67d79900bbb..720bf8f7e51 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at.3.rst @@ -6,7 +6,7 @@ MPI_File_write_at .. include_body -:ref:`MPI_File_write_at` - Writes a file at an explicitly specified offset +:ref:`MPI_File_write_at` |mdash| Writes a file at an explicitly specified offset (blocking, noncollective). @@ -81,7 +81,7 @@ specified by the current view. :ref:`MPI_File_write_at` stores the number of *datatype* elements actually written in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst index 814257fa5f5..dda2f15de57 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst @@ -6,7 +6,7 @@ MPI_File_write_at_all .. include_body -:ref:`MPI_File_write_at_all` - Writes a file at explicitly specified +:ref:`MPI_File_write_at_all` |mdash| Writes a file at explicitly specified offsets (blocking, collective). @@ -81,7 +81,7 @@ written into those parts of the file specified by the current view. :ref:`MPI_File_write_at_all` stores the number of *datatype* elements actually written in *status.* All other fields of *status* are undefined. -It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was +It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened. diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst index 006059d773f..47bccebcd4b 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst @@ -6,7 +6,7 @@ MPI_File_write_at_all_begin .. include_body -:ref:`MPI_File_write_at_all_begin` - Writes a file at explicitly specified +:ref:`MPI_File_write_at_all_begin` |mdash| Writes a file at explicitly specified offsets; beginning part of a split collective routine (nonblocking). @@ -85,7 +85,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst index 398e8144d76..18379e9c532 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst @@ -6,7 +6,7 @@ MPI_File_write_at_all_end .. include_body -:ref:`MPI_File_write_at_all_end` - Writes a file at explicitly specified +:ref:`MPI_File_write_at_all_end` |mdash| Writes a file at explicitly specified offsets; ending part of a split collective routine (blocking). @@ -78,7 +78,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst index a71debc3ce4..f523b13164d 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst @@ -5,7 +5,7 @@ MPI_File_write_ordered .. include_body -:ref:`MPI_File_write_ordered` - Writes a file at a location specified by a +:ref:`MPI_File_write_ordered` |mdash| Writes a file at a location specified by a shared file pointer (blocking, collective). SYNTAX diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst index 077bf9140e5..b7f0a3fdde6 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst @@ -5,7 +5,7 @@ MPI_File_write_ordered_begin .. include_body -:ref:`MPI_File_write_ordered_begin` - Writes a file at a location specified +:ref:`MPI_File_write_ordered_begin` |mdash| Writes a file at a location specified by a shared file pointer; beginning part of a split collective routine (nonblocking). @@ -85,7 +85,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst index b2c422ddb3e..0de79cb5f5b 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst @@ -5,7 +5,7 @@ MPI_File_write_ordered_end .. include_body -:ref:`MPI_File_write_ordered_end` - Writes a file at a location specified +:ref:`MPI_File_write_ordered_end` |mdash| Writes a file at a location specified by a shared file pointer; ending part of a split collective routine (blocking). @@ -76,7 +76,7 @@ NOTES ----- All the nonblocking collective routines for data access are "split" into -two routines, each with \_begin or \_end as a suffix. These split +two routines, each with ``_begin`` or ``_end`` as a suffix. These split collective routines are subject to the semantic rules described in Section 9.4.5 of the MPI-2 standard. diff --git a/docs/man-openmpi/man3/MPI_File_write_shared.3.rst b/docs/man-openmpi/man3/MPI_File_write_shared.3.rst index aec00a07725..40a985bdfb5 100644 --- a/docs/man-openmpi/man3/MPI_File_write_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_shared.3.rst @@ -5,7 +5,7 @@ MPI_File_write_shared .. include_body -:ref:`MPI_File_write_shared` - Writes a file using the shared file pointer +:ref:`MPI_File_write_shared` |mdash| Writes a file using the shared file pointer (blocking, noncollective). SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Finalize.3.rst b/docs/man-openmpi/man3/MPI_Finalize.3.rst index 3fef1fe0d46..174b0c77ebb 100644 --- a/docs/man-openmpi/man3/MPI_Finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_Finalize.3.rst @@ -5,7 +5,7 @@ MPI_Finalize .. include_body -:ref:`MPI_Finalize` - Terminates MPI execution environment. +:ref:`MPI_Finalize` |mdash| Terminates MPI execution environment. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Finalized.3.rst b/docs/man-openmpi/man3/MPI_Finalized.3.rst index 6d34fa9ded6..84c3e71d7a1 100644 --- a/docs/man-openmpi/man3/MPI_Finalized.3.rst +++ b/docs/man-openmpi/man3/MPI_Finalized.3.rst @@ -5,7 +5,7 @@ MPI_Finalized .. include_body -:ref:`MPI_Finalized` - Checks whether MPI has been finalized +:ref:`MPI_Finalized` |mdash| Checks whether MPI has been finalized SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Free_mem.3.rst b/docs/man-openmpi/man3/MPI_Free_mem.3.rst index faff69f2fc7..280bbe7ac36 100644 --- a/docs/man-openmpi/man3/MPI_Free_mem.3.rst +++ b/docs/man-openmpi/man3/MPI_Free_mem.3.rst @@ -5,7 +5,7 @@ MPI_Free_mem .. include_body -:ref:`MPI_Free_mem` - Frees memory that has been allocated using :ref:`MPI_Alloc_mem`. +:ref:`MPI_Free_mem` |mdash| Frees memory that has been allocated using :ref:`MPI_Alloc_mem`. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Gather.3.rst b/docs/man-openmpi/man3/MPI_Gather.3.rst index 6a37a659d02..8cfe7d4c3a8 100644 --- a/docs/man-openmpi/man3/MPI_Gather.3.rst +++ b/docs/man-openmpi/man3/MPI_Gather.3.rst @@ -175,7 +175,7 @@ Example 1: Gather 100 ints from every process in group to root. MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm); -Example 2: Previous example modified -- only the root allocates memory +Example 2: Previous example modified |mdash| only the root allocates memory for the receive buffer. .. code-block:: c diff --git a/docs/man-openmpi/man3/MPI_Get_address.3.rst b/docs/man-openmpi/man3/MPI_Get_address.3.rst index cc7e999be0a..b773c88ec7f 100644 --- a/docs/man-openmpi/man3/MPI_Get_address.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_address.3.rst @@ -5,7 +5,7 @@ MPI_Get_address .. include_body -:ref:`MPI_Get_address` - Gets the address of a location in memory. +:ref:`MPI_Get_address` |mdash| Gets the address of a location in memory. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Get_count.3.rst b/docs/man-openmpi/man3/MPI_Get_count.3.rst index d33da12e69b..a4ee54ad428 100644 --- a/docs/man-openmpi/man3/MPI_Get_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_count.3.rst @@ -5,7 +5,7 @@ MPI_Get_count .. include_body -:ref:`MPI_Get_count` - Gets the number of top-level elements received. +:ref:`MPI_Get_count` |mdash| Gets the number of top-level elements received. SYNTAX ------ @@ -61,10 +61,11 @@ DESCRIPTION Returns the number of entries received. (We count entries, each of type datatype, not bytes.) The datatype argument should match the argument -provided by the receive call that set the status variable. (As explained -in Section 3.12.5 in the MPI-1 Standard, "Use of General Datatypes in -Communication," :ref:`MPI_Get_count` may, in certain situations, return the -value MPI_UNDEFINED.) +provided by the receive call that set the status variable. As explained +in the "Use of General Datatypes in Communication" section of the `MPI +Standard `_. +:ref:`MPI_Get_count` may, in certain situations, return the value +``MPI_UNDEFINED``. The datatype argument is passed to :ref:`MPI_Get_count` to improve performance. A message might be received without counting the number of elements it @@ -77,7 +78,7 @@ NOTES If the size of the datatype is zero, this routine will return a count of zero. If the amount of data in status is not an exact multiple of the size of datatype (so that count would not be integral), a count of -MPI_UNDEFINED is returned instead. +``MPI_UNDEFINED`` is returned instead. ERRORS ------ @@ -85,6 +86,6 @@ ERRORS .. include:: ./ERRORS.rst If the value to be returned is larger than can fit into the count -parameter, an MPI_ERR_TRUNCATE error is raised. +parameter, an ``MPI_ERR_TRUNCATE`` error is raised. .. seealso:: :ref:`MPI_Get_elements` diff --git a/docs/man-openmpi/man3/MPI_Get_library_version.3.rst b/docs/man-openmpi/man3/MPI_Get_library_version.3.rst index 10d9d9ab9b9..b2f344b877e 100644 --- a/docs/man-openmpi/man3/MPI_Get_library_version.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_library_version.3.rst @@ -5,7 +5,7 @@ MPI_Get_library_version .. include_body -:ref:`MPI_Get_library_version` - Returns a string of the current Open MPI +:ref:`MPI_Get_library_version` |mdash| Returns a string of the current Open MPI version SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst b/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst index 01b849ffee9..33040ae022e 100644 --- a/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst @@ -5,7 +5,7 @@ MPI_Get_processor_name .. include_body -:ref:`MPI_Get_processor_name` - Gets the name of the processor. +:ref:`MPI_Get_processor_name` |mdash| Gets the name of the processor. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Get_version.3.rst b/docs/man-openmpi/man3/MPI_Get_version.3.rst index 4f1302bad41..85768d6b094 100644 --- a/docs/man-openmpi/man3/MPI_Get_version.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_version.3.rst @@ -5,7 +5,7 @@ MPI_Get_version .. include_body -:ref:`MPI_Get_version` - Returns the version of the standard corresponding +:ref:`MPI_Get_version` |mdash| Returns the version of the standard corresponding to the current implementation. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Graph_create.3.rst b/docs/man-openmpi/man3/MPI_Graph_create.3.rst index ae521006711..28248aaf7b4 100644 --- a/docs/man-openmpi/man3/MPI_Graph_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_create.3.rst @@ -5,7 +5,7 @@ MPI_Graph_create .. include_body -:ref:`MPI_Graph_create` - Makes a new communicator to which topology +:ref:`MPI_Graph_create` |mdash| Makes a new communicator to which topology information has been attached. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Graph_get.3.rst b/docs/man-openmpi/man3/MPI_Graph_get.3.rst index e6fe77e9cf4..89107044b36 100644 --- a/docs/man-openmpi/man3/MPI_Graph_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_get.3.rst @@ -5,7 +5,7 @@ MPI_Graph_get .. include_body -:ref:`MPI_Graph_get` - Retrieves graph topology information associated with a +:ref:`MPI_Graph_get` |mdash| Retrieves graph topology information associated with a communicator. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Graph_map.3.rst b/docs/man-openmpi/man3/MPI_Graph_map.3.rst index 1d4bd3d730f..95d3889f6a3 100644 --- a/docs/man-openmpi/man3/MPI_Graph_map.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_map.3.rst @@ -5,7 +5,7 @@ MPI_Graph_map .. include_body -:ref:`MPI_Graph_map` - Maps process to graph topology information. +:ref:`MPI_Graph_map` |mdash| Maps process to graph topology information. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst b/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst index badcc89c9df..abfa8ff57d7 100644 --- a/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst @@ -6,7 +6,7 @@ MPI_Graph_neighbors .. include_body -:ref:`MPI_Graph_neighbors` - Returns the neighbors of a node associated +:ref:`MPI_Graph_neighbors` |mdash| Returns the neighbors of a node associated with a graph topology. diff --git a/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst b/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst index 229f5d9d81b..f2bfa2ed3ba 100644 --- a/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst @@ -5,7 +5,7 @@ MPI_Graph_neighbors_count .. include_body -:ref:`MPI_Graph_neighbors_count` - Returns the number of neighbors of a node +:ref:`MPI_Graph_neighbors_count` |mdash| Returns the number of neighbors of a node associated with a graph topology. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst b/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst index 60c3b846e54..2fecb9e7cbf 100644 --- a/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst @@ -5,7 +5,7 @@ MPI_Graphdims_get .. include_body -:ref:`MPI_Graphdims_get` - Retrieves graph topology information associated with +:ref:`MPI_Graphdims_get` |mdash| Retrieves graph topology information associated with a communicator. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst b/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst index 48b13b06220..e6181c99d86 100644 --- a/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst +++ b/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst @@ -5,7 +5,7 @@ MPI_Grequest_complete .. include_body -:ref:`MPI_Grequest_complete` - Reports that a generalized request is +:ref:`MPI_Grequest_complete` |mdash| Reports that a generalized request is complete. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst index 84abe2f40ec..acd94beb0f2 100644 --- a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst +++ b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst @@ -5,7 +5,7 @@ MPI_Grequest_start .. include_body -:ref:`MPI_Grequest_start` - Starts a generalized request and returns a +:ref:`MPI_Grequest_start` |mdash| Starts a generalized request and returns a handle to it in ``request``. SYNTAX @@ -188,12 +188,12 @@ then the error code returned by the callback function will be returned by the MPI function that invoked the callback function. In the case of a ``MPI_{Wait|Test}any`` call that invokes both ``query_fn`` and ``free_fn``, the MPI call will return the error code returned by the -last callback, namely ``free_fn``. If one or more of the ``request``\ s +last callback, namely ``free_fn``. If one or more of the ``request``s in a call to ``MPI_{Wait|Test}{some|all``} has failed, then the MPI call -will return MPI_ERR_IN_STATUS. In such a case, if the MPI call was +will return ``MPI_ERR_IN_STATUS``. In such a case, if the MPI call was passed an array of statuses, then MPI will return in each of the statuses that correspond to a completed generalized ``request`` the error code returned by the corresponding invocation of its ``free_fn`` callback function. However, if the MPI function was passed -MPI_STATUSES_IGNORE, then the individual error codes returned by +``MPI_STATUSES_IGNORE``, then the individual error codes returned by each callback function will be lost. diff --git a/docs/man-openmpi/man3/MPI_Group_compare.3.rst b/docs/man-openmpi/man3/MPI_Group_compare.3.rst index 13b19633627..aa589c7fa3f 100644 --- a/docs/man-openmpi/man3/MPI_Group_compare.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_compare.3.rst @@ -5,7 +5,7 @@ MPI_Group_compare .. include_body -:ref:`MPI_Group_compare` - Compares two groups. +:ref:`MPI_Group_compare` |mdash| Compares two groups. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Group_difference.3.rst b/docs/man-openmpi/man3/MPI_Group_difference.3.rst index 2cad3cd8287..888df71ceee 100644 --- a/docs/man-openmpi/man3/MPI_Group_difference.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_difference.3.rst @@ -5,7 +5,7 @@ MPI_Group_difference .. include_body -:ref:`MPI_Group_difference` - Makes a group from the difference of two groups. +:ref:`MPI_Group_difference` |mdash| Makes a group from the difference of two groups. SYNTAX ------ @@ -60,11 +60,11 @@ DESCRIPTION The set-like operations are defined as follows: -* union -- All elements of the first group (group1), followed by all +* union |mdash| All elements of the first group (group1), followed by all elements of second group (group2) that are not in the first group -* intersect -- all elements of the first group that are also in the +* intersect |mdash| all elements of the first group that are also in the second group, ordered as in first group -* difference -- all elements of the first group that are not in the +* difference |mdash| all elements of the first group that are not in the second group, ordered as in the first group Note that for these operations the order of processes in the output diff --git a/docs/man-openmpi/man3/MPI_Group_excl.3.rst b/docs/man-openmpi/man3/MPI_Group_excl.3.rst index 4081b6abd56..12cf6399d3e 100644 --- a/docs/man-openmpi/man3/MPI_Group_excl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_excl.3.rst @@ -5,7 +5,7 @@ MPI_Group_excl .. include_body -:ref:`MPI_Group_excl` - Produces a group by reordering an existing group and +:ref:`MPI_Group_excl` |mdash| Produces a group by reordering an existing group and taking only unlisted members. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Group_free.3.rst b/docs/man-openmpi/man3/MPI_Group_free.3.rst index 4f31fe0e5e9..4c78c3f124c 100644 --- a/docs/man-openmpi/man3/MPI_Group_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_free.3.rst @@ -5,7 +5,7 @@ MPI_Group_free .. include_body -:ref:`MPI_Group_free` - Frees a group. +:ref:`MPI_Group_free` |mdash| Frees a group. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst b/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst index e4da04f80c3..1575c50e3d3 100644 --- a/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_from_session_pset.3.rst @@ -5,7 +5,7 @@ MPI_Group_from_session_pset .. include_body -:ref:`MPI_Group_from_session_pset` - Creates a group using a provided session +:ref:`MPI_Group_from_session_pset` |mdash| Creates a group using a provided session handle and process set. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Group_incl.3.rst b/docs/man-openmpi/man3/MPI_Group_incl.3.rst index b5fd771aa71..b0de02e5caf 100644 --- a/docs/man-openmpi/man3/MPI_Group_incl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_incl.3.rst @@ -5,7 +5,7 @@ MPI_Group_incl .. include_body -:ref:`MPI_Group_incl` - Produces a group by reordering an existing group and +:ref:`MPI_Group_incl` |mdash| Produces a group by reordering an existing group and taking only listed members. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Group_intersection.3.rst b/docs/man-openmpi/man3/MPI_Group_intersection.3.rst index b664d27e1a4..88779bd0905 100644 --- a/docs/man-openmpi/man3/MPI_Group_intersection.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_intersection.3.rst @@ -5,7 +5,7 @@ MPI_Group_intersection .. include_body -:ref:`MPI_Group_intersection` - Produces a group at the intersection of two +:ref:`MPI_Group_intersection` |mdash| Produces a group at the intersection of two existing groups. SYNTAX @@ -61,11 +61,11 @@ DESCRIPTION The set-like operations are defined as follows: -* union -- All elements of the first group (group1), followed by all +* union |mdash| All elements of the first group (group1), followed by all elements of second group (group2) not in first. -* intersect -- all elements of the first group that are also in the +* intersect |mdash| all elements of the first group that are also in the second group, ordered as in first group. -* difference -- all elements of the first group that are not in the +* difference |mdash| all elements of the first group that are not in the second group, ordered as in the first group. Note that for these operations the order of processes in the output diff --git a/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst b/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst index 49262f863cd..d63f64083d8 100644 --- a/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst @@ -6,7 +6,7 @@ MPI_Group_range_excl .. include_body -:ref:`MPI_Group_range_excl` - Produces a group by excluding ranges of +:ref:`MPI_Group_range_excl` |mdash| Produces a group by excluding ranges of processes from an existing group. diff --git a/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst b/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst index 4e38690a528..3500793dd41 100644 --- a/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst @@ -6,7 +6,7 @@ MPI_Group_range_incl .. include_body -:ref:`MPI_Group_range_incl` - Creates a new group from ranges of ranks in +:ref:`MPI_Group_range_incl` |mdash| Creates a new group from ranges of ranks in an existing group. diff --git a/docs/man-openmpi/man3/MPI_Group_rank.3.rst b/docs/man-openmpi/man3/MPI_Group_rank.3.rst index 43415f10d6d..f59c50202b5 100644 --- a/docs/man-openmpi/man3/MPI_Group_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_rank.3.rst @@ -6,7 +6,7 @@ MPI_Group_rank .. include_body -:ref:`MPI_Group_rank` - Returns the rank of the calling process in the +:ref:`MPI_Group_rank` |mdash| Returns the rank of the calling process in the given group. diff --git a/docs/man-openmpi/man3/MPI_Group_size.3.rst b/docs/man-openmpi/man3/MPI_Group_size.3.rst index e8cf2ffaeaf..12e934f2122 100644 --- a/docs/man-openmpi/man3/MPI_Group_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_size.3.rst @@ -6,7 +6,7 @@ MPI_Group_size .. include_body -:ref:`MPI_Group_size` - Returns the size of a group. +:ref:`MPI_Group_size` |mdash| Returns the size of a group. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst b/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst index 70e893779df..5e8ccfc3083 100644 --- a/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst @@ -6,7 +6,7 @@ MPI_Group_translate_ranks .. include_body -:ref:`MPI_Group_translate_ranks` - Translates the ranks of processes in one +:ref:`MPI_Group_translate_ranks` |mdash| Translates the ranks of processes in one group to those in another group. diff --git a/docs/man-openmpi/man3/MPI_Group_union.3.rst b/docs/man-openmpi/man3/MPI_Group_union.3.rst index 7087154824f..6673231ce9a 100644 --- a/docs/man-openmpi/man3/MPI_Group_union.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_union.3.rst @@ -6,7 +6,7 @@ MPI_Group_union .. include_body -:ref:`MPI_Group_union` - Produces a group by combining two groups. +:ref:`MPI_Group_union` |mdash| Produces a group by combining two groups. SYNTAX @@ -62,11 +62,11 @@ DESCRIPTION The set-like operations are defined as follows: - o union -- All elements of the first group (group1), followed by all elements of second group (group2) not in first. + o union |mdash| All elements of the first group (group1), followed by all elements of second group (group2) not in first. - o intersect -- all elements of the first group that are also in the second group, ordered as in first group. + o intersect |mdash| all elements of the first group that are also in the second group, ordered as in first group. - o difference -- all elements of the first group that are not in the second group, ordered as in the first group. + o difference |mdash| all elements of the first group that are not in the second group, ordered as in the first group. Note that for these operations the order of processes in the output group is determined primarily by order in the first group (if possible) diff --git a/docs/man-openmpi/man3/MPI_Ibsend.3.rst b/docs/man-openmpi/man3/MPI_Ibsend.3.rst index 5a5f92765b3..dfa5aaa4229 100644 --- a/docs/man-openmpi/man3/MPI_Ibsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Ibsend.3.rst @@ -6,7 +6,7 @@ MPI_Ibsend .. include_body -:ref:`MPI_Ibsend` - Starts a nonblocking buffered send. +:ref:`MPI_Ibsend` |mdash| Starts a nonblocking buffered send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Improbe.3.rst b/docs/man-openmpi/man3/MPI_Improbe.3.rst index a15d7588521..b8d7b940f55 100644 --- a/docs/man-openmpi/man3/MPI_Improbe.3.rst +++ b/docs/man-openmpi/man3/MPI_Improbe.3.rst @@ -6,7 +6,7 @@ MPI_Improbe .. include_body -:ref:`MPI_Improbe` - Non-blocking matched probe for a message. +:ref:`MPI_Improbe` |mdash| Non-blocking matched probe for a message. SYNTAX @@ -79,7 +79,7 @@ receive buffer according to the length of the probed message. A matching probe with ``MPI_PROC_NULL`` as *source* returns *flag* = true, -*message* =`` MPI_MESSAGE_NO_PROC``, and the *status* object returns source +*message* = ``MPI_MESSAGE_NO_PROC``, and the *status* object returns source ^ ``MPI_PROC_NULL``, tag ^ ``MPI_ANY_TAG``, and count ^ 0. :ref:`MPI_Iprobe` returns a true value in *flag* if a message has been matched diff --git a/docs/man-openmpi/man3/MPI_Imrecv.3.rst b/docs/man-openmpi/man3/MPI_Imrecv.3.rst index 2bc46c6dd17..cdff127f7eb 100644 --- a/docs/man-openmpi/man3/MPI_Imrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Imrecv.3.rst @@ -6,7 +6,7 @@ MPI_Imrecv .. include_body -:ref:`MPI_Imrecv` - Non-blocking receive for a matched message +:ref:`MPI_Imrecv` |mdash| Non-blocking receive for a matched message SYNTAX @@ -72,7 +72,7 @@ previously matched by a matching probe. The *request* returned from :ref:`MPI_Imrecv` can be used with any of the :ref:`MPI_Test` and :ref:`MPI_Wait` variants, like any non-blocking receive request. -If :ref:`MPI_Imrecv` is called with MPI_MESSAGE_NULL as the message argument, a +If :ref:`MPI_Imrecv` is called with ``MPI_MESSAGE_NULL`` as the message argument, a call to one of the :ref:`MPI_Test` or :ref:`MPI_Wait` variants will return immediately with the *status* object set to *source* = ``MPI_PROC_NULL``, *tag* = ``MPI_ANY_TAG``, and *count* = 0, as if a receive from ``MPI_PROC_NULL`` was @@ -81,14 +81,18 @@ issued. If reception of a matched message is started with :ref:`MPI_Imrecv`, then it is possible to cancel the returned request with :ref:`MPI_Cancel`. If :ref:`MPI_Cancel` succeeds, the matched message must be found by a subsequent message -probe (:ref:`MPI_Probe`, :ref:`MPI_Iprobe`, :ref:`MPI_Mprobe`, or MPI_Improbe), received by a +probe (:ref:`MPI_Probe`, :ref:`MPI_Iprobe`, :ref:`MPI_Mprobe`, or :ref:`MPI_Improbe`), received by a subsequent receive operation or canceled by the sender. Note, however, that is it possible for the cancellation of operations initiated with :ref:`MPI_Imrecv` to fail. An example of a failing case is when canceling the matched message receive would violate MPI message ordering rules (e.g., if another message matching the same message signature has -matched -- and possible received -- before this :ref:`MPI_Imrecv` is canceled). +matched |mdash| and possibly received |mdash| before this :ref:`MPI_Imrecv` is canceled). + +If your application does not need to examine the *status* field, you +can save resources by using the predefined constant +``MPI_STATUS_IGNORE`` as a special value for the *status* argument. ERRORS @@ -96,6 +100,16 @@ ERRORS .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages received +by :ref:`MPI_Imrecv` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_Imrecv` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. + .. seealso:: * :ref:`MPI_Mprobe` * :ref:`MPI_Improbe` diff --git a/docs/man-openmpi/man3/MPI_Info_create.3.rst b/docs/man-openmpi/man3/MPI_Info_create.3.rst index a287a05e397..fe84b0ec68f 100644 --- a/docs/man-openmpi/man3/MPI_Info_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_create.3.rst @@ -6,7 +6,7 @@ MPI_Info_create .. include_body -:ref:`MPI_Info_create` - Creates a new info object. +:ref:`MPI_Info_create` |mdash| Creates a new info object. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Info_create_env.3.rst b/docs/man-openmpi/man3/MPI_Info_create_env.3.rst index 45e9895c96d..9add14f7a99 100644 --- a/docs/man-openmpi/man3/MPI_Info_create_env.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_create_env.3.rst @@ -6,7 +6,7 @@ MPI_Info_create_env .. include_body -:ref:`MPI_Info_create_env` - Creates a new info object with the same construction as :ref:`MPI_INFO_ENV` as created during :ref:`MPI_Init` or :ref:`MPI_Init_thread` when the same arguments +:ref:`MPI_Info_create_env` |mdash| Creates a new info object with the same construction as :ref:`MPI_INFO_ENV` as created during :ref:`MPI_Init` or :ref:`MPI_Init_thread` when the same arguments are used. diff --git a/docs/man-openmpi/man3/MPI_Info_delete.3.rst b/docs/man-openmpi/man3/MPI_Info_delete.3.rst index ebc77a06099..713ba77a2c8 100644 --- a/docs/man-openmpi/man3/MPI_Info_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_delete.3.rst @@ -6,7 +6,7 @@ MPI_Info_delete .. include_body -:ref:`MPI_Info_delete` - Deletes a key/value pair from *info*. +:ref:`MPI_Info_delete` |mdash| Deletes a key/value pair from *info*. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Info_dup.3.rst b/docs/man-openmpi/man3/MPI_Info_dup.3.rst index 737798230fe..c834941b546 100644 --- a/docs/man-openmpi/man3/MPI_Info_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_dup.3.rst @@ -6,7 +6,7 @@ MPI_Info_dup .. include_body -:ref:`MPI_Info_dup` - Duplicates an info object. +:ref:`MPI_Info_dup` |mdash| Duplicates an info object. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Info_env.3.rst b/docs/man-openmpi/man3/MPI_Info_env.3.rst index b672c741f66..650b23a610c 100644 --- a/docs/man-openmpi/man3/MPI_Info_env.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_env.3.rst @@ -6,7 +6,7 @@ MPI_Info_env .. include_body -:ref:`MPI_INFO_ENV` - Static MPI_Info object containing info about the +:ref:`MPI_INFO_ENV` |mdash| Static MPI_Info object containing info about the application diff --git a/docs/man-openmpi/man3/MPI_Info_free.3.rst b/docs/man-openmpi/man3/MPI_Info_free.3.rst index d9b082b54b2..89a08507607 100644 --- a/docs/man-openmpi/man3/MPI_Info_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_free.3.rst @@ -6,7 +6,7 @@ MPI_Info_free .. include_body -:ref:`MPI_Info_free` - Frees an info object. +:ref:`MPI_Info_free` |mdash| Frees an info object. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Info_get.3.rst b/docs/man-openmpi/man3/MPI_Info_get.3.rst index 7aaef7a0975..c45f2f7627b 100644 --- a/docs/man-openmpi/man3/MPI_Info_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get.3.rst @@ -6,7 +6,7 @@ MPI_Info_get .. include_body -:ref:`MPI_Info_get` - Retrieves the value associated with a key in an info +:ref:`MPI_Info_get` |mdash| Retrieves the value associated with a key in an info object. diff --git a/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst b/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst index 6c859cfbec6..8fac7d214b1 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst @@ -6,7 +6,7 @@ MPI_Info_get_nkeys .. include_body -:ref:`MPI_Info_get_nkeys` - Gets the number of keys currently defined in an +:ref:`MPI_Info_get_nkeys` |mdash| Gets the number of keys currently defined in an info object. diff --git a/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst b/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst index a5810c843f1..3009c17ab33 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst @@ -6,7 +6,7 @@ MPI_Info_get_nthkey .. include_body -:ref:`MPI_Info_get_nthkey` - Returns the *n*\ th defined key in *info*. +:ref:`MPI_Info_get_nthkey` |mdash| Returns the *n*\ th defined key in *info*. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Info_get_string.3.rst b/docs/man-openmpi/man3/MPI_Info_get_string.3.rst index fddd75e0b35..169ebdbb200 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_string.3.rst @@ -6,7 +6,7 @@ MPI_Info_get_string .. include_body -:ref:`MPI_Info_get_string` - Retrieves the value associated with a key in +:ref:`MPI_Info_get_string` |mdash| Retrieves the value associated with a key in an info object. diff --git a/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst b/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst index 6d8d9456499..776b14089bd 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst @@ -6,7 +6,7 @@ MPI_Info_get_valuelen .. include_body -:ref:`MPI_Info_get_valuelen` - Retrieves the length of the key value +:ref:`MPI_Info_get_valuelen` |mdash| Retrieves the length of the key value associated with an info object. diff --git a/docs/man-openmpi/man3/MPI_Info_set.3.rst b/docs/man-openmpi/man3/MPI_Info_set.3.rst index 8162b8c3caa..58d8b393b31 100644 --- a/docs/man-openmpi/man3/MPI_Info_set.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_set.3.rst @@ -6,7 +6,7 @@ MPI_Info_set .. include_body -:ref:`MPI_Info_set` - Adds a key/value pair to *info*. +:ref:`MPI_Info_set` |mdash| Adds a key/value pair to *info*. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Init.3.rst b/docs/man-openmpi/man3/MPI_Init.3.rst index ffa0f0891bb..6477ec495c9 100644 --- a/docs/man-openmpi/man3/MPI_Init.3.rst +++ b/docs/man-openmpi/man3/MPI_Init.3.rst @@ -6,7 +6,7 @@ MPI_Init .. include_body -:ref:`MPI_Init` - Initializes the MPI execution environment +:ref:`MPI_Init` |mdash| Initializes the MPI execution environment SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Init_thread.3.rst b/docs/man-openmpi/man3/MPI_Init_thread.3.rst index 2e1389d9e6d..e5173ff90a4 100644 --- a/docs/man-openmpi/man3/MPI_Init_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_Init_thread.3.rst @@ -6,7 +6,7 @@ MPI_Init_thread .. include_body -:ref:`MPI_Init_thread` - Initializes the MPI execution environment +:ref:`MPI_Init_thread` |mdash| Initializes the MPI execution environment SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Initialized.3.rst b/docs/man-openmpi/man3/MPI_Initialized.3.rst index 65f222e6cda..069d089c7dc 100644 --- a/docs/man-openmpi/man3/MPI_Initialized.3.rst +++ b/docs/man-openmpi/man3/MPI_Initialized.3.rst @@ -6,7 +6,7 @@ MPI_Initialized .. include_body -:ref:`MPI_Initialized` - Checks whether MPI has been initialized +:ref:`MPI_Initialized` |mdash| Checks whether MPI has been initialized SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst index 8b73fa57686..db3f9aa2da2 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst @@ -6,7 +6,7 @@ MPI_Intercomm_create .. include_body -:ref:`MPI_Intercomm_create` - Creates an intercommunicator from two +:ref:`MPI_Intercomm_create` |mdash| Creates an intercommunicator from two intracommunicators. 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 b6495f90692..b7da254eb9a 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 @@ -5,7 +5,7 @@ MPI_Intercomm_create_from_groups .. include_body -:ref:`MPI_Intercomm_create_from_groups` - Creates a new inter-communicator from +:ref:`MPI_Intercomm_create_from_groups` |mdash| Creates a new inter-communicator from a local and remote group and stringtag SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst index e7d95f33d50..8961bff9e3a 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst @@ -6,7 +6,7 @@ MPI_Intercomm_merge .. include_body -:ref:`MPI_Intercomm_merge` - Creates an intracommunicator from an +:ref:`MPI_Intercomm_merge` |mdash| Creates an intracommunicator from an intercommunicator. diff --git a/docs/man-openmpi/man3/MPI_Iprobe.3.rst b/docs/man-openmpi/man3/MPI_Iprobe.3.rst index 9eb65607362..5edc6ac91ed 100644 --- a/docs/man-openmpi/man3/MPI_Iprobe.3.rst +++ b/docs/man-openmpi/man3/MPI_Iprobe.3.rst @@ -6,7 +6,7 @@ MPI_Iprobe .. include_body -:ref:`MPI_Iprobe` - Nonblocking test for a message. +:ref:`MPI_Iprobe` |mdash| Nonblocking test for a message. SYNTAX @@ -72,19 +72,20 @@ the information returned by status). In particular, the user may allocate memory for the receive buffer, according to the length of the probed message. -``MPI_Iprobe(source, tag, comm, flag, status)`` returns flag = true if there +``MPI_Iprobe(source, tag, comm, flag, status)`` returns *flag* = true if there is a message that can be received and that matches the pattern specified by the arguments source, tag, and comm. The call matches the same message that would have been received by a call to ``MPI_Recv(..., source, tag, comm, status)`` executed at the same point in the program, and returns in status the same value that would have been returned by -:ref:`MPI_Recv`. Otherwise, the call returns flag = false, and leaves status +:ref:`MPI_Recv`. Otherwise, the call returns *flag* = false, and leaves status undefined. -If :ref:`MPI_Iprobe` returns flag = true, then the content of the status object -can be subsequently accessed as described in Section 3.2.5 of the MPI-1 -Standard, "Return Status," to find the source, tag, and length of the -probed message. +If :ref:`MPI_Iprobe` returns *flag* = true, then the content of the +status object can be subsequently accessed as described in the "Return +Status" subsection of the "Point-to-Point Communication" chapter in +the `MPI Standard `_ to find the +source, tag, and length of the probed message. A subsequent receive executed with the same context, and the source and tag returned in status by :ref:`MPI_Iprobe` will receive the message that was @@ -109,8 +110,9 @@ it is received. NOTE ---- -Users of libmpi-mt should remember that two threads may do an :ref:`MPI_Iprobe` -that actually returns true for the same message for both threads. +Multi-threaded application developers should remember that two threads +calling :ref:`MPI_Iprobe` may return true for the same message in both +threads. ERRORS @@ -118,6 +120,16 @@ ERRORS .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages queried +by :ref:`MPI_Iprobe` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_Iprobe` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. + .. seealso:: * :ref:`MPI_Probe` * :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Irecv.3.rst b/docs/man-openmpi/man3/MPI_Irecv.3.rst index 289486b7eec..c321d0ca9b0 100644 --- a/docs/man-openmpi/man3/MPI_Irecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Irecv.3.rst @@ -6,7 +6,7 @@ MPI_Irecv .. include_body -:ref:`MPI_Irecv` - Starts a standard-mode, nonblocking receive. +:ref:`MPI_Irecv` |mdash| Starts a standard-mode, nonblocking receive. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Irsend.3.rst b/docs/man-openmpi/man3/MPI_Irsend.3.rst index 8c52eed0de2..389f9e17230 100644 --- a/docs/man-openmpi/man3/MPI_Irsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Irsend.3.rst @@ -6,7 +6,7 @@ MPI_Irsend .. include_body -:ref:`MPI_Irsend` - Starts a ready-mode nonblocking send. +:ref:`MPI_Irsend` |mdash| Starts a ready-mode nonblocking send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst b/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst index b0b175b68ad..e465705c490 100644 --- a/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst +++ b/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst @@ -6,7 +6,7 @@ MPI_Is_thread_main .. include_body -:ref:`MPI_Is_thread_main` - Determines if thread called :ref:`MPI_Init` +:ref:`MPI_Is_thread_main` |mdash| Determines if thread called :ref:`MPI_Init` SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Isend.3.rst b/docs/man-openmpi/man3/MPI_Isend.3.rst index 119cc3b5dc4..bb1ffe7ba23 100644 --- a/docs/man-openmpi/man3/MPI_Isend.3.rst +++ b/docs/man-openmpi/man3/MPI_Isend.3.rst @@ -6,7 +6,7 @@ MPI_Isend .. include_body -:ref:`MPI_Isend` - Starts a standard-mode, nonblocking send. +:ref:`MPI_Isend` |mdash| Starts a standard-mode, nonblocking send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Isendrecv.3.rst b/docs/man-openmpi/man3/MPI_Isendrecv.3.rst index 582b3d0e68e..3ebf0cf7789 100644 --- a/docs/man-openmpi/man3/MPI_Isendrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Isendrecv.3.rst @@ -6,7 +6,7 @@ MPI_Isendrecv .. include_body -:ref:`MPI_Isendrecv` - Sends and receives a message. +:ref:`MPI_Isendrecv` |mdash| Sends and receives a message. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst b/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst index 47e77ed7864..27b9e95776c 100644 --- a/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst +++ b/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst @@ -6,7 +6,7 @@ MPI_Isendrecv_replace .. include_body -:ref:`MPI_Isendrecv_replace` - Sends and receives a message using a single +:ref:`MPI_Isendrecv_replace` |mdash| Sends and receives a message using a single buffer. diff --git a/docs/man-openmpi/man3/MPI_Issend.3.rst b/docs/man-openmpi/man3/MPI_Issend.3.rst index c1303136ab2..cb9914241f4 100644 --- a/docs/man-openmpi/man3/MPI_Issend.3.rst +++ b/docs/man-openmpi/man3/MPI_Issend.3.rst @@ -6,7 +6,7 @@ MPI_Issend .. include_body -:ref:`MPI_Issend` - Starts a nonblocking synchronous send. +:ref:`MPI_Issend` |mdash| Starts a nonblocking synchronous send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst index a750d0ae3af..a98f4a55f0e 100644 --- a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst @@ -6,7 +6,7 @@ MPI_Keyval_create .. include_body -:ref:`MPI_Keyval_create` - Generates a new attribute key -- |deprecated_favor| :ref:`MPI_Comm_create_keyval`. +:ref:`MPI_Keyval_create` |mdash| Generates a new attribute key |mdash| |deprecated_favor| :ref:`MPI_Comm_create_keyval`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst index fe7e289b095..e7b7d19b0a6 100644 --- a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst @@ -6,7 +6,7 @@ MPI_Keyval_free .. include_body -:ref:`MPI_Keyval_free` - Frees attribute key for communicator cache attribute -- |deprecated_favor| :ref:`MPI_Comm_free_keyval`. +:ref:`MPI_Keyval_free` |mdash| Frees attribute key for communicator cache attribute |mdash| |deprecated_favor| :ref:`MPI_Comm_free_keyval`. SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Mprobe.3.rst b/docs/man-openmpi/man3/MPI_Mprobe.3.rst index 3fc818fceca..9aea077659d 100644 --- a/docs/man-openmpi/man3/MPI_Mprobe.3.rst +++ b/docs/man-openmpi/man3/MPI_Mprobe.3.rst @@ -6,7 +6,7 @@ MPI_Mprobe .. include_body -:ref:`MPI_Mprobe` - Blocking matched probe for a message. +:ref:`MPI_Mprobe` |mdash| Blocking matched probe for a message. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Mrecv.3.rst b/docs/man-openmpi/man3/MPI_Mrecv.3.rst index 4e84ff5422b..dabd8d4dc9c 100644 --- a/docs/man-openmpi/man3/MPI_Mrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Mrecv.3.rst @@ -6,7 +6,7 @@ MPI_Mrecv .. include_body -:ref:`MPI_Mrecv` - Blocking receive for a matched message +:ref:`MPI_Mrecv` |mdash| Blocking receive for a matched message SYNTAX @@ -70,17 +70,31 @@ DESCRIPTION The functions :ref:`MPI_Mrecv` and :ref:`MPI_Imrecv` receive messages that have been previously matched by a matching probe. -If :ref:`MPI_Mrecv` is called with MPI_MESSAGE_NULL as the message argument, +If :ref:`MPI_Mrecv` is called with ``MPI_MESSAGE_NULL`` as the message argument, the call returns immediately with the *status* object set to *source* = ``MPI_PROC_NULL``, *tag* = ``MPI_ANY_TAG``, and *count* = 0, as if a receive from ``MPI_PROC_NULL`` was issued. +If your application does not need to examine the *status* field, you +can save resources by using the predefined constant +``MPI_STATUS_IGNORE`` as a special value for the *status* argument. + ERRORS ------ .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages received +by :ref:`MPI_Mrecv` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_Mrecv` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. + .. seealso:: * :ref:`MPI_Mprobe` * :ref:`MPI_Improbe` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst index 0a45ed74d70..8bf2e3da04e 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst @@ -7,7 +7,7 @@ MPI_Neighbor_allgather .. include_body :ref:`MPI_Neighbor_allgather`, :ref:`MPI_Ineighbor_allgather`, -:ref:`MPI_Neighbor_allgather` - Gathers and distributes data from and to all +:ref:`MPI_Neighbor_allgather` |mdash| Gathers and distributes data from and to all neighbors diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst index 8d38287dfea..541872143ba 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst @@ -7,7 +7,7 @@ MPI_Neighbor_allgatherv .. include_body :ref:`MPI_Neighbor_allgatherv`, :ref:`MPI_Ineighbor_allgatherv`, -:ref:`MPI_Neighbor_allgatherv_init` - Gathers and distributes data from and +:ref:`MPI_Neighbor_allgatherv_init` |mdash| Gathers and distributes data from and to all neighbors. Each process may contribute a different amount of data. diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst index 835718a98e6..1922689eefd 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst @@ -7,7 +7,7 @@ MPI_Neighbor_alltoallv .. include_body :ref:`MPI_Neighbor_alltoallv`, :ref:`MPI_Ineighbor_alltoallv`, -:ref:`MPI_Neighbor_alltoallv_init` - All processes send different amounts of +:ref:`MPI_Neighbor_alltoallv_init` |mdash| All processes send different amounts of data to, and receive different amounts of data from, all neighbors diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst index 01f9d8ee667..0f14919a8fe 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst @@ -7,7 +7,7 @@ MPI_Neighbor_alltoallw .. include_body :ref:`MPI_Neighbor_alltoallw`, :ref:`MPI_Ineighbor_alltoallw`, -:ref:`MPI_Neighbor_alltoallw_init` - All processes send data of different +:ref:`MPI_Neighbor_alltoallw_init` |mdash| All processes send data of different types to, and receive data of different types from, all processes diff --git a/docs/man-openmpi/man3/MPI_Op_commutative.3.rst b/docs/man-openmpi/man3/MPI_Op_commutative.3.rst index d56dd43185c..6efa8fc9768 100644 --- a/docs/man-openmpi/man3/MPI_Op_commutative.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_commutative.3.rst @@ -6,7 +6,7 @@ MPI_Op_commutative .. include_body -:ref:`MPI_Op_commutative` - Query of commutativity of reduction operation. +:ref:`MPI_Op_commutative` |mdash| Query of commutativity of reduction operation. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Op_create.3.rst b/docs/man-openmpi/man3/MPI_Op_create.3.rst index 4f1467a9f7a..87868a72871 100644 --- a/docs/man-openmpi/man3/MPI_Op_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_create.3.rst @@ -6,7 +6,7 @@ MPI_Op_create .. include_body -:ref:`MPI_Op_create` - Creates a user-defined combination function handle. +:ref:`MPI_Op_create` |mdash| Creates a user-defined combination function handle. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Op_free.3.rst b/docs/man-openmpi/man3/MPI_Op_free.3.rst index 454507a527b..636906210a9 100644 --- a/docs/man-openmpi/man3/MPI_Op_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_free.3.rst @@ -6,7 +6,7 @@ MPI_Op_free .. include_body -:ref:`MPI_Op_free` - Frees a user-defined combination function handle. +:ref:`MPI_Op_free` |mdash| Frees a user-defined combination function handle. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Open_port.3.rst b/docs/man-openmpi/man3/MPI_Open_port.3.rst index b4c03998f87..d39025e0106 100644 --- a/docs/man-openmpi/man3/MPI_Open_port.3.rst +++ b/docs/man-openmpi/man3/MPI_Open_port.3.rst @@ -6,7 +6,7 @@ MPI_Open_port .. include_body -:ref:`MPI_Open_port` - Establishes a network address for a server to accept +:ref:`MPI_Open_port` |mdash| Establishes a network address for a server to accept connections from clients. diff --git a/docs/man-openmpi/man3/MPI_Pack.3.rst b/docs/man-openmpi/man3/MPI_Pack.3.rst index 6ab5c44b73a..db05406c841 100644 --- a/docs/man-openmpi/man3/MPI_Pack.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack.3.rst @@ -6,7 +6,7 @@ MPI_Pack .. include_body -:ref:`MPI_Pack` - Packs data of a given datatype into contiguous memory. +:ref:`MPI_Pack` |mdash| Packs data of a given datatype into contiguous memory. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Pack_external.3.rst b/docs/man-openmpi/man3/MPI_Pack_external.3.rst index afd2d185bcc..fae2d17397a 100644 --- a/docs/man-openmpi/man3/MPI_Pack_external.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_external.3.rst @@ -6,7 +6,7 @@ MPI_Pack_external .. include_body -:ref:`MPI_Pack_external` - Writes data to a portable format +:ref:`MPI_Pack_external` |mdash| Writes data to a portable format SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst b/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst index 66e34f4765c..bd31130d539 100644 --- a/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst @@ -6,7 +6,7 @@ MPI_Pack_external_size .. include_body -:ref:`MPI_Pack_external_size` - Calculates upper bound on space needed to +:ref:`MPI_Pack_external_size` |mdash| Calculates upper bound on space needed to write to a portable format diff --git a/docs/man-openmpi/man3/MPI_Pack_size.3.rst b/docs/man-openmpi/man3/MPI_Pack_size.3.rst index 66baa466d36..dfecc6552f8 100644 --- a/docs/man-openmpi/man3/MPI_Pack_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_size.3.rst @@ -6,7 +6,7 @@ MPI_Pack_size .. include_body -:ref:`MPI_Pack_size` - Returns the upper bound on the amount of space +:ref:`MPI_Pack_size` |mdash| Returns the upper bound on the amount of space needed to pack a message. diff --git a/docs/man-openmpi/man3/MPI_Parrived.3.rst b/docs/man-openmpi/man3/MPI_Parrived.3.rst index 98873ff97f0..bc32d7031d8 100644 --- a/docs/man-openmpi/man3/MPI_Parrived.3.rst +++ b/docs/man-openmpi/man3/MPI_Parrived.3.rst @@ -6,7 +6,7 @@ MPI_Parrived .. include_body -:ref:`MPI_Parrived` - Tests for completion of a specified receive-side +:ref:`MPI_Parrived` |mdash| Tests for completion of a specified receive-side partition. diff --git a/docs/man-openmpi/man3/MPI_Pcontrol.3.rst b/docs/man-openmpi/man3/MPI_Pcontrol.3.rst index 46fe3d273fe..26b2fe43f63 100644 --- a/docs/man-openmpi/man3/MPI_Pcontrol.3.rst +++ b/docs/man-openmpi/man3/MPI_Pcontrol.3.rst @@ -6,7 +6,7 @@ MPI_Pcontrol .. include_body -:ref:`MPI_Pcontrol` - Controls profiling. +:ref:`MPI_Pcontrol` |mdash| Controls profiling. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Pready.3.rst b/docs/man-openmpi/man3/MPI_Pready.3.rst index 8bc64601726..728b7053cc8 100644 --- a/docs/man-openmpi/man3/MPI_Pready.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready.3.rst @@ -6,7 +6,7 @@ MPI_Pready .. include_body -:ref:`MPI_Pready` - Indicates that a given send-side partition is ready to +:ref:`MPI_Pready` |mdash| Indicates that a given send-side partition is ready to be transferred. diff --git a/docs/man-openmpi/man3/MPI_Pready_list.3.rst b/docs/man-openmpi/man3/MPI_Pready_list.3.rst index 38ed8614fd4..55bffac2651 100644 --- a/docs/man-openmpi/man3/MPI_Pready_list.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready_list.3.rst @@ -6,7 +6,7 @@ MPI_Pready_list .. include_body -:ref:`MPI_Pready_list` - Indicates that a list given send-side partitions +:ref:`MPI_Pready_list` |mdash| Indicates that a list given send-side partitions are ready to be transferred. diff --git a/docs/man-openmpi/man3/MPI_Pready_range.3.rst b/docs/man-openmpi/man3/MPI_Pready_range.3.rst index 4e617168926..a6758c7606b 100644 --- a/docs/man-openmpi/man3/MPI_Pready_range.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready_range.3.rst @@ -6,7 +6,7 @@ MPI_Pready_range .. include_body -:ref:`MPI_Pready_range` - Indicates that a given range os send-side +:ref:`MPI_Pready_range` |mdash| Indicates that a given range os send-side partitions are ready to be transferred. diff --git a/docs/man-openmpi/man3/MPI_Precv_init.3.rst b/docs/man-openmpi/man3/MPI_Precv_init.3.rst index b3b17487abd..153c7673fe5 100644 --- a/docs/man-openmpi/man3/MPI_Precv_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Precv_init.3.rst @@ -6,7 +6,7 @@ MPI_Precv_init .. include_body -:ref:`MPI_Precv_init` - Initializes a partitioned receive. +:ref:`MPI_Precv_init` |mdash| Initializes a partitioned receive. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Probe.3.rst b/docs/man-openmpi/man3/MPI_Probe.3.rst index b60ecc049fe..c6936286579 100644 --- a/docs/man-openmpi/man3/MPI_Probe.3.rst +++ b/docs/man-openmpi/man3/MPI_Probe.3.rst @@ -6,7 +6,7 @@ MPI_Probe .. include_body -:ref:`MPI_Probe` - Blocking test for a message. +:ref:`MPI_Probe` |mdash| Blocking test for a message. SYNTAX @@ -81,7 +81,7 @@ will return, unless the message is received by another concurrent receive operation (that is executed by another thread at the probing process). Similarly, if a process busy waits with :ref:`MPI_Iprobe` and a matching message has been issued, then the call to :ref:`MPI_Iprobe` will -eventually return flag = true unless the message is received by another +eventually return *flag* = true unless the message is received by another concurrent receive operation. **Example 1:** Use blocking probe to wait for an incoming message. @@ -143,6 +143,16 @@ ERRORS .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages queried +by :ref:`MPI_Probe` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_Probe` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. + .. seealso:: * :ref:`MPI_Iprobe` * :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Psend_init.3.rst b/docs/man-openmpi/man3/MPI_Psend_init.3.rst index 686be34fda6..ba894f0a947 100644 --- a/docs/man-openmpi/man3/MPI_Psend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Psend_init.3.rst @@ -6,7 +6,7 @@ MPI_Psend_init .. include_body -:ref:`MPI_Psend_init` - Initializes a partitioned send. +:ref:`MPI_Psend_init` |mdash| Initializes a partitioned send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Publish_name.3.rst b/docs/man-openmpi/man3/MPI_Publish_name.3.rst index ef1a87c33b2..f4728761436 100644 --- a/docs/man-openmpi/man3/MPI_Publish_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Publish_name.3.rst @@ -6,7 +6,7 @@ MPI_Publish_name .. include_body -:ref:`MPI_Publish_name` - Publishes a service name associated with a port +:ref:`MPI_Publish_name` |mdash| Publishes a service name associated with a port SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Query_thread.3.rst b/docs/man-openmpi/man3/MPI_Query_thread.3.rst index 4f472d45170..7613b3d4e47 100644 --- a/docs/man-openmpi/man3/MPI_Query_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_Query_thread.3.rst @@ -6,7 +6,7 @@ MPI_Query_thread .. include_body -:ref:`MPI_Query_thread` - Returns the current level of thread support +:ref:`MPI_Query_thread` |mdash| Returns the current level of thread support SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Recv.3.rst b/docs/man-openmpi/man3/MPI_Recv.3.rst index 76f84c5aec7..fc6ae575fe5 100644 --- a/docs/man-openmpi/man3/MPI_Recv.3.rst +++ b/docs/man-openmpi/man3/MPI_Recv.3.rst @@ -6,7 +6,7 @@ MPI_Recv .. include_body -:ref:`MPI_Recv` - Performs a standard-mode blocking receive. +:ref:`MPI_Recv` |mdash| Performs a standard-mode blocking receive. SYNTAX @@ -74,8 +74,9 @@ after the receive buffer contains the newly received message. A receive can complete before the matching send has completed (of course, it can complete only after the matching send has started). -The blocking semantics of this call are described in Section 3.4 of the -MPI-1 Standard, "Communication Modes." +The blocking semantics of this call are described in the +"Communication Modes" section of the `MPI Standard +`_. The receive buffer contains a number (defined by the value of *count*) of consecutive elements. The first element in the set of elements is @@ -99,10 +100,11 @@ The *count* argument indicates the maximum number of entries of type received, use the :ref:`MPI_Get_count` function to determine the actual number of entries within that message. -To receive messages of unknown length, use the :ref:`MPI_Probe` function. (For -more information about :ref:`MPI_Probe` and :ref:`MPI_Cancel`, see their respective -man pages; also, see Section 3.8 of the MPI-1 Standard, "Probe and -Cancel.") +To receive messages of unknown length, use the :ref:`MPI_Probe` +function. For more information about :ref:`MPI_Probe` and +:ref:`MPI_Cancel`, see their respective man pages and the "Probe and +Cancel" section of the `MPI Standard +`_. A message can be received by a receive operation only if it is addressed to the receiving process, and if its source, tag, and communicator @@ -133,8 +135,9 @@ by the receiver). Source = destination is allowed, that is, a process can send a message to itself. However, it is not recommended for a process to send messages to itself using the blocking send and receive operations described -above, since this may lead to deadlock. See Section 3.5 of the MPI-1 -Standard, "Semantics of Point-to-Point Communication." +above, since this may lead to deadlock. See the "Semantics of +Point-to-Point Communication" of the `MPI Standard +`_ for more details. If your application does not need to examine the *status* field, you can save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a @@ -146,6 +149,16 @@ ERRORS .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages received +by :ref:`MPI_Recv` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_Recv` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. + .. seealso:: * :ref:`MPI_Irecv` * :ref:`MPI_Probe` diff --git a/docs/man-openmpi/man3/MPI_Recv_init.3.rst b/docs/man-openmpi/man3/MPI_Recv_init.3.rst index 45c72fc9056..e47265348f7 100644 --- a/docs/man-openmpi/man3/MPI_Recv_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Recv_init.3.rst @@ -6,7 +6,7 @@ MPI_Recv_init .. include_body -:ref:`MPI_Recv_init` - Builds a handle for a receive. +:ref:`MPI_Recv_init` |mdash| Builds a handle for a receive. SYNTAX @@ -76,7 +76,7 @@ Creates a persistent communication request for a receive operation. The argument *buf* is marked as OUT because the user gives permission to write on the receive buffer by passing the argument to :ref:`MPI_Recv_init`. -A persistent communication request is inactive after it is created -- no +A persistent communication request is inactive after it is created |mdash| no active communication is attached to the request. A communication (send or receive) that uses a persistent request is diff --git a/docs/man-openmpi/man3/MPI_Reduce_local.3.rst b/docs/man-openmpi/man3/MPI_Reduce_local.3.rst index 056e428b97d..d079a538eac 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_local.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_local.3.rst @@ -6,7 +6,7 @@ MPI_Reduce_local .. include_body -:ref:`MPI_Reduce_local` - Perform a local reduction +:ref:`MPI_Reduce_local` |mdash| Perform a local reduction SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst index 07e425843c4..deb70025f4c 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst @@ -7,7 +7,7 @@ MPI_Reduce_scatter_block .. include_body :ref:`MPI_Reduce_scatter_block`, :ref:`MPI_Ireduce_scatter_block`, -:ref:`MPI_Reduce_scatter_block_init` - Combines values and scatters the +:ref:`MPI_Reduce_scatter_block_init` |mdash| Combines values and scatters the results in blocks. diff --git a/docs/man-openmpi/man3/MPI_Register_datarep.3.rst b/docs/man-openmpi/man3/MPI_Register_datarep.3.rst index 1cde254d7ac..0a5592490ea 100644 --- a/docs/man-openmpi/man3/MPI_Register_datarep.3.rst +++ b/docs/man-openmpi/man3/MPI_Register_datarep.3.rst @@ -6,7 +6,7 @@ MPI_Register_datarep .. include_body -:ref:`MPI_Register_datarep` - Defines data representation. +:ref:`MPI_Register_datarep` |mdash| Defines data representation. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Request_free.3.rst b/docs/man-openmpi/man3/MPI_Request_free.3.rst index 924efc170c4..26c2abd50af 100644 --- a/docs/man-openmpi/man3/MPI_Request_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Request_free.3.rst @@ -6,7 +6,7 @@ MPI_Request_free .. include_body -:ref:`MPI_Request_free` - Frees a communication request object. +:ref:`MPI_Request_free` |mdash| Frees a communication request object. SYNTAX @@ -68,13 +68,13 @@ Once a request is freed by a call to :ref:`MPI_Request_free`, it is not possible to check for the successful completion of the associated communication with calls to :ref:`MPI_Wait` or :ref:`MPI_Test`. Also, if an error occurs subsequently during the communication, an error code cannot be -returned to the user -- such an error must be treated as fatal. +returned to the user |mdash| such an error must be treated as fatal. Questions arise as to how one knows when the operations have completed when using :ref:`MPI_Request_free`. Depending on the program logic, there may be other ways in which the program knows that certain operations have completed and this makes usage of :ref:`MPI_Request_free` practical. For example, an active send request could be freed when the logic of the -program is such that the receiver sends a reply to the message sent -- +program is such that the receiver sends a reply to the message sent |mdash| the arrival of the reply informs the sender that the send has completed and the send buffer can be reused. An active receive request should never be freed, as the receiver will have no way to verify that the diff --git a/docs/man-openmpi/man3/MPI_Request_get_status.3.rst b/docs/man-openmpi/man3/MPI_Request_get_status.3.rst index cdd456310cb..6b4e41de214 100644 --- a/docs/man-openmpi/man3/MPI_Request_get_status.3.rst +++ b/docs/man-openmpi/man3/MPI_Request_get_status.3.rst @@ -6,7 +6,7 @@ MPI_Request_get_status .. include_body -:ref:`MPI_Request_get_status` - Access information associated with a +:ref:`MPI_Request_get_status` |mdash| Access information associated with a request without freeing the request. diff --git a/docs/man-openmpi/man3/MPI_Rsend.3.rst b/docs/man-openmpi/man3/MPI_Rsend.3.rst index 92a5f95be93..92e0ac742ac 100644 --- a/docs/man-openmpi/man3/MPI_Rsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Rsend.3.rst @@ -6,7 +6,7 @@ MPI_Rsend .. include_body -:ref:`MPI_Rsend` - Ready send. +:ref:`MPI_Rsend` |mdash| Ready send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Rsend_init.3.rst b/docs/man-openmpi/man3/MPI_Rsend_init.3.rst index 1ec661a7031..b76563e8b66 100644 --- a/docs/man-openmpi/man3/MPI_Rsend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Rsend_init.3.rst @@ -6,7 +6,7 @@ MPI_Rsend_init .. include_body -:ref:`MPI_Rsend_init` - Builds a handle for a ready send. +:ref:`MPI_Rsend_init` |mdash| Builds a handle for a ready send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Send.3.rst b/docs/man-openmpi/man3/MPI_Send.3.rst index b8839edc3df..69af46f6048 100644 --- a/docs/man-openmpi/man3/MPI_Send.3.rst +++ b/docs/man-openmpi/man3/MPI_Send.3.rst @@ -6,7 +6,7 @@ MPI_Send .. include_body -:ref:`MPI_Send` - Performs a standard-mode blocking send. +:ref:`MPI_Send` |mdash| Performs a standard-mode blocking send. SYNTAX @@ -74,7 +74,7 @@ NOTE This routine will block until the message is sent to the destination. For an in-depth explanation of the semantics of the standard-mode send, -refer to the MPI-1 Standard. +refer to the `MPI Standard `_. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Send_init.3.rst b/docs/man-openmpi/man3/MPI_Send_init.3.rst index fcf4706f17a..d5dfc86bbe5 100644 --- a/docs/man-openmpi/man3/MPI_Send_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Send_init.3.rst @@ -6,7 +6,7 @@ MPI_Send_init .. include_body -:ref:`MPI_Send_init` - Builds a handle for a standard send. +:ref:`MPI_Send_init` |mdash| Builds a handle for a standard send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Sendrecv.3.rst b/docs/man-openmpi/man3/MPI_Sendrecv.3.rst index 0f2cc82def0..a44f43d3368 100644 --- a/docs/man-openmpi/man3/MPI_Sendrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Sendrecv.3.rst @@ -6,7 +6,7 @@ MPI_Sendrecv .. include_body -:ref:`MPI_Sendrecv` - Sends and receives a message. +:ref:`MPI_Sendrecv` |mdash| Sends and receives a message. SYNTAX @@ -92,8 +92,9 @@ example, even processes send, then receive; odd processes receive first, then send) in order to prevent cyclic dependencies that may lead to deadlock. When a send-receive operation is used, the communication subsystem takes care of these issues. The send-receive operation can be -used in conjunction with the functions described in Chapter 6 of the -MPI-1 Standard, "Process Topologies," in order to perform shifts on +used in conjunction with the functions described in the "Process +Topologies" chapter in the `MPI Standard +`_ in order to perform shifts on various logical topologies. Also, a send-receive operation is useful for implementing remote procedure calls. @@ -116,5 +117,15 @@ ERRORS .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages received +by :ref:`MPI_Sendrecv` do not set the ``status.MPI_ERROR`` field in +the returned *status*. The error code is always passed to the +back-end error handler and may be passed back to the caller through +the return value of :ref:`MPI_Sendrecv` if the back-end error handler +returns it. The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` +exhibits this behavior, for example. + .. seealso:: * :ref:`MPI_Sendrecv_replace` diff --git a/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst b/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst index 7843bfed92a..8d34772fed3 100644 --- a/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst +++ b/docs/man-openmpi/man3/MPI_Sendrecv_replace.3.rst @@ -6,7 +6,7 @@ MPI_Sendrecv_replace .. include_body -:ref:`MPI_Sendrecv_replace` - Sends and receives a message using a single +:ref:`MPI_Sendrecv_replace` |mdash| Sends and receives a message using a single buffer. @@ -112,5 +112,15 @@ ERRORS .. include:: ./ERRORS.rst +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on messages received +by :ref:`MPI_Sendrecv_replace` do not set the ``status.MPI_ERROR`` +field in the returned *status*. The error code is always passed to +the back-end error handler and may be passed back to the caller +through the return value of :ref:`MPI_Sendrecv_replace` if the +back-end error handler returns it. The pre-defined MPI error handler +``MPI_ERRORS_RETURN`` exhibits this behavior, for example. + .. seealso:: * :ref:`MPI_Sendrecv` diff --git a/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst index 599e91234f6..16e9330d2ab 100644 --- a/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_call_errhandler.3.rst @@ -5,7 +5,7 @@ MPI_Session_call_errhandler .. include_body -:ref:`MPI_Session_call_errhandler` - Passes the supplied error code to the error +:ref:`MPI_Session_call_errhandler` |mdash| Passes the supplied error code to the error handler assigned to a session SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst index 5bac8378a6d..251e2fd4d1a 100644 --- a/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst @@ -5,7 +5,7 @@ MPI_Session_create_errhandler .. include_body -:ref:`MPI_Session_create_errhandler` - Creates an error handler that can be +:ref:`MPI_Session_create_errhandler` |mdash| Creates an error handler that can be attached to sessions SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Session_finalize.3.rst b/docs/man-openmpi/man3/MPI_Session_finalize.3.rst index 81c4b367890..b91e2085a6b 100644 --- a/docs/man-openmpi/man3/MPI_Session_finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_finalize.3.rst @@ -5,7 +5,7 @@ MPI_Session_finalize .. include_body -:ref:`MPI_Session_finalize` - releases all MPI state associated with a session +:ref:`MPI_Session_finalize` |mdash| releases all MPI state associated with a session SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst index 14d2a83cb41..fb085229d78 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Session_get_errhandler .. include_body -:ref:`MPI_Session_get_errhandler` - Retrieves error handler associated with a +:ref:`MPI_Session_get_errhandler` |mdash| Retrieves error handler associated with a session. diff --git a/docs/man-openmpi/man3/MPI_Session_get_info.3.rst b/docs/man-openmpi/man3/MPI_Session_get_info.3.rst index d5fe6c279c8..bd8af5c048c 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_info.3.rst @@ -5,7 +5,7 @@ MPI_Session_get_info .. include_body -:ref:`MPI_Session_get_info` - Returns an info object containing the hints of an +:ref:`MPI_Session_get_info` |mdash| Returns an info object containing the hints of an MPI Session SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst b/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst index da131c4ea36..2d9d9d313b4 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_nth_pset.3.rst @@ -5,7 +5,7 @@ MPI_Session_get_nth_pset .. include_body -:ref:`MPI_Session_get_nth_pset` - Query runtime for name of the nth process set +:ref:`MPI_Session_get_nth_pset` |mdash| Query runtime for name of the nth process set SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst b/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst index 03ca454aa74..d4690b78f33 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_num_psets.3.rst @@ -5,7 +5,7 @@ MPI_Session_get_num_psets .. include_body -:ref:`MPI_Session_get_num_psets` - Query runtime for number of available +:ref:`MPI_Session_get_num_psets` |mdash| Query runtime for number of available process sets SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst b/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst index a92d11e737d..fa787992428 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_pset_info.3.rst @@ -5,7 +5,7 @@ MPI_Session_get_pset_info .. include_body -:ref:`MPI_Session_get_pset_info` - Returns an info object containing properties +:ref:`MPI_Session_get_pset_info` |mdash| Returns an info object containing properties of a specific process set SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Session_init.3.rst b/docs/man-openmpi/man3/MPI_Session_init.3.rst index d309a0f3a6c..813ad196a83 100644 --- a/docs/man-openmpi/man3/MPI_Session_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_init.3.rst @@ -5,7 +5,7 @@ MPI_Session_init .. include_body -:ref:`MPI_Session_init` - Creates a new session handle +:ref:`MPI_Session_init` |mdash| Creates a new session handle SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst index b5a158782ac..186f5fcf711 100644 --- a/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Session_set_errhandler .. include_body -:ref:`MPI_Session_set_errhandler` - Attaches a new error handler to a +:ref:`MPI_Session_set_errhandler` |mdash| Attaches a new error handler to a session. diff --git a/docs/man-openmpi/man3/MPI_Sizeof.3.rst b/docs/man-openmpi/man3/MPI_Sizeof.3.rst index 27e804629de..27e18edffd9 100644 --- a/docs/man-openmpi/man3/MPI_Sizeof.3.rst +++ b/docs/man-openmpi/man3/MPI_Sizeof.3.rst @@ -6,7 +6,7 @@ MPI_Sizeof .. include_body -:ref:`MPI_Sizeof` - Returns the size, in bytes, of the given type +:ref:`MPI_Sizeof` |mdash| Returns the size, in bytes, of the given type SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Ssend.3.rst b/docs/man-openmpi/man3/MPI_Ssend.3.rst index 2354d5808db..e1f06aba36b 100644 --- a/docs/man-openmpi/man3/MPI_Ssend.3.rst +++ b/docs/man-openmpi/man3/MPI_Ssend.3.rst @@ -6,7 +6,7 @@ MPI_Ssend .. include_body -:ref:`MPI_Ssend` - Standard synchronous send. +:ref:`MPI_Ssend` |mdash| Standard synchronous send. SYNTAX @@ -66,8 +66,9 @@ OUTPUT PARAMETER DESCRIPTION ----------- -:ref:`MPI_Ssend` performs a synchronous-mode, blocking send. See the MPI-1 -Standard for more detailed information about such sends. +:ref:`MPI_Ssend` performs a synchronous-mode, blocking send. See the +`MPI Standard `_ for +more detailed information about such sends. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Ssend_init.3.rst b/docs/man-openmpi/man3/MPI_Ssend_init.3.rst index 2d214a5140c..c8b65ca6ef2 100644 --- a/docs/man-openmpi/man3/MPI_Ssend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Ssend_init.3.rst @@ -6,7 +6,7 @@ MPI_Ssend_init .. include_body -:ref:`MPI_Ssend_init` - Builds a handle for a synchronous send. +:ref:`MPI_Ssend_init` |mdash| Builds a handle for a synchronous send. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Start.3.rst b/docs/man-openmpi/man3/MPI_Start.3.rst index fc943577068..1cb01efb6d8 100644 --- a/docs/man-openmpi/man3/MPI_Start.3.rst +++ b/docs/man-openmpi/man3/MPI_Start.3.rst @@ -6,7 +6,7 @@ MPI_Start .. include_body -:ref:`MPI_Start` - Initiates a communication using a persistent request +:ref:`MPI_Start` |mdash| Initiates a communication using a persistent request handle. @@ -72,7 +72,8 @@ until after the operation completes, the communication buffer should not be accessed. The call is local, with semantics similar to the nonblocking -communication operations (see Section 3.7 in the MPI-1 Standard, +communication operations (see Section 3.7 in the `MPI Standard +`_, "Nonblocking Communication.") That is, a call to :ref:`MPI_Start` with a request created by :ref:`MPI_Send_init` starts a communication in the same manner as a call to :ref:`MPI_Isend`; a call to :ref:`MPI_Start` with a request diff --git a/docs/man-openmpi/man3/MPI_Startall.3.rst b/docs/man-openmpi/man3/MPI_Startall.3.rst index 24beade39cb..d081e76e3df 100644 --- a/docs/man-openmpi/man3/MPI_Startall.3.rst +++ b/docs/man-openmpi/man3/MPI_Startall.3.rst @@ -6,7 +6,7 @@ MPI_Startall .. include_body -:ref:`MPI_Startall` - Starts a collection of requests. +:ref:`MPI_Startall` |mdash| Starts a collection of requests. SYNTAX @@ -70,13 +70,15 @@ A communication started with a call to :ref:`MPI_Start` or :ref:`MPI_Startall` i completed by a call to :ref:`MPI_Wait`, :ref:`MPI_Test`, or one of the derived functions :ref:`MPI_Waitany`, :ref:`MPI_Testany`, :ref:`MPI_Waitall`, :ref:`MPI_Testall`, :ref:`MPI_Waitsome`, :ref:`MPI_Testsome` (these are described in Section 3.7.5 of the -MPI-1 Standard, "Multiple Completions"). The request becomes inactive +`MPI Standard `_, "Multiple +Completions"). The request becomes inactive after successful completion by such a call. The request is not deallocated, and it can be activated anew by another :ref:`MPI_Start` or :ref:`MPI_Startall` call. -A persistent request is deallocated by a call to :ref:`MPI_Request_free` (see -Section 3.7.3 of the MPI-1 Standard, "Communication Completion"). +A persistent request is deallocated by a call to +:ref:`MPI_Request_free` (see Section 3.7.3 of the `MPI Standard +`_, "Communication Completion"). | The call to :ref:`MPI_Request_free` can occur at any point in the program after the persistent request was created. However, the request will be diff --git a/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst b/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst index 3735109c253..0ebb9ffc2cc 100644 --- a/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst @@ -6,7 +6,7 @@ MPI_Status_set_cancelled .. include_body -:ref:`MPI_Status_set_cancelled` - Sets *status* to indicate a request has +:ref:`MPI_Status_set_cancelled` |mdash| Sets *status* to indicate a request has been canceled. diff --git a/docs/man-openmpi/man3/MPI_T_category_changed.3.rst b/docs/man-openmpi/man3/MPI_T_category_changed.3.rst index 1628c13d9ae..e6b6e488712 100644 --- a/docs/man-openmpi/man3/MPI_T_category_changed.3.rst +++ b/docs/man-openmpi/man3/MPI_T_category_changed.3.rst @@ -6,7 +6,7 @@ MPI_T_category_changed .. include_body -:ref:`MPI_T_category_changed` - Get a timestamp for the categories +:ref:`MPI_T_category_changed` |mdash| Get a timestamp for the categories SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_category_get_categories.3.rst b/docs/man-openmpi/man3/MPI_T_category_get_categories.3.rst index 843066102a3..671c2823a10 100644 --- a/docs/man-openmpi/man3/MPI_T_category_get_categories.3.rst +++ b/docs/man-openmpi/man3/MPI_T_category_get_categories.3.rst @@ -6,7 +6,7 @@ MPI_T_category_get_categories .. include_body -:ref:`MPI_T_category_get_categories` - Query which categories are in a +:ref:`MPI_T_category_get_categories` |mdash| Query which categories are in a category diff --git a/docs/man-openmpi/man3/MPI_T_category_get_cvars.3.rst b/docs/man-openmpi/man3/MPI_T_category_get_cvars.3.rst index 3a389dfa707..f25fa67abaa 100644 --- a/docs/man-openmpi/man3/MPI_T_category_get_cvars.3.rst +++ b/docs/man-openmpi/man3/MPI_T_category_get_cvars.3.rst @@ -6,7 +6,7 @@ MPI_T_category_get_cvars .. include_body -:ref:`MPI_T_category_get_cvars` - Query which control variables are in a +:ref:`MPI_T_category_get_cvars` |mdash| Query which control variables are in a category diff --git a/docs/man-openmpi/man3/MPI_T_category_get_info.3.rst b/docs/man-openmpi/man3/MPI_T_category_get_info.3.rst index 389d765411c..a44923137d9 100644 --- a/docs/man-openmpi/man3/MPI_T_category_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_T_category_get_info.3.rst @@ -6,7 +6,7 @@ MPI_T_category_get_info .. include_body -:ref:`MPI_T_category_get_info` - Query information from a category +:ref:`MPI_T_category_get_info` |mdash| Query information from a category SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_category_get_num.3.rst b/docs/man-openmpi/man3/MPI_T_category_get_num.3.rst index 2033a69d396..df19f0f2bcc 100644 --- a/docs/man-openmpi/man3/MPI_T_category_get_num.3.rst +++ b/docs/man-openmpi/man3/MPI_T_category_get_num.3.rst @@ -6,7 +6,7 @@ MPI_T_category_get_num .. include_body -:ref:`MPI_T_category_get_num` - Query the number of categories +:ref:`MPI_T_category_get_num` |mdash| Query the number of categories SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_category_get_pvars.3.rst b/docs/man-openmpi/man3/MPI_T_category_get_pvars.3.rst index 814783ae19f..e14be2ef999 100644 --- a/docs/man-openmpi/man3/MPI_T_category_get_pvars.3.rst +++ b/docs/man-openmpi/man3/MPI_T_category_get_pvars.3.rst @@ -6,7 +6,7 @@ MPI_T_category_get_pvars .. include_body -:ref:`MPI_T_category_get_pvars` - Query which performance variables are in +:ref:`MPI_T_category_get_pvars` |mdash| Query which performance variables are in a category diff --git a/docs/man-openmpi/man3/MPI_T_cvar_get_info.3.rst b/docs/man-openmpi/man3/MPI_T_cvar_get_info.3.rst index 1f34cc0e505..3415aa04230 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_get_info.3.rst @@ -8,7 +8,7 @@ MPI_T_cvar_get_info .. include_body -:ref:`MPI_T_cvar_get_info` - Query information from a control variable +:ref:`MPI_T_cvar_get_info` |mdash| Query information from a control variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_cvar_get_num.3.rst b/docs/man-openmpi/man3/MPI_T_cvar_get_num.3.rst index 978bf19a2d5..2baff026118 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_get_num.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_get_num.3.rst @@ -6,7 +6,7 @@ MPI_T_cvar_get_num .. include_body -:ref:`MPI_T_cvar_get_num` - Query the number of control variables +:ref:`MPI_T_cvar_get_num` |mdash| Query the number of control variables SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_cvar_read.3.rst b/docs/man-openmpi/man3/MPI_T_cvar_read.3.rst index ca4ab6a858a..09c74428728 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_read.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_read.3.rst @@ -6,7 +6,7 @@ MPI_T_cvar_read .. include_body -:ref:`MPI_T_cvar_read` - Read the value of a control variable +:ref:`MPI_T_cvar_read` |mdash| Read the value of a control variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_cvar_write.3.rst b/docs/man-openmpi/man3/MPI_T_cvar_write.3.rst index 651008bd635..b0e9b6c83ac 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_write.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_write.3.rst @@ -6,7 +6,7 @@ MPI_T_cvar_write .. include_body -:ref:`MPI_T_cvar_write` - Write the value of a bound control variable +:ref:`MPI_T_cvar_write` |mdash| Write the value of a bound control variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_enum_get_info.3.rst b/docs/man-openmpi/man3/MPI_T_enum_get_info.3.rst index 094b246a0df..86b4701e48f 100644 --- a/docs/man-openmpi/man3/MPI_T_enum_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_T_enum_get_info.3.rst @@ -6,7 +6,7 @@ MPI_T_enum_get_info .. include_body -:ref:`MPI_T_enum_get_info` - Query information about an enumerator +:ref:`MPI_T_enum_get_info` |mdash| Query information about an enumerator SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_enum_get_item.3.rst b/docs/man-openmpi/man3/MPI_T_enum_get_item.3.rst index e9354a35610..7ff4be97ced 100644 --- a/docs/man-openmpi/man3/MPI_T_enum_get_item.3.rst +++ b/docs/man-openmpi/man3/MPI_T_enum_get_item.3.rst @@ -6,7 +6,7 @@ MPI_T_enum_get_item .. include_body -:ref:`MPI_T_enum_get_item` - Query information about an enumerator +:ref:`MPI_T_enum_get_item` |mdash| Query information about an enumerator SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_finalize.3.rst b/docs/man-openmpi/man3/MPI_T_finalize.3.rst index 54246cb5a06..29ab3a9f7ca 100644 --- a/docs/man-openmpi/man3/MPI_T_finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_T_finalize.3.rst @@ -6,7 +6,7 @@ MPI_T_finalize .. include_body -:ref:`MPI_T_finalize` - Finalize the MPI tool information interface +:ref:`MPI_T_finalize` |mdash| Finalize the MPI tool information interface SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_init_thread.3.rst b/docs/man-openmpi/man3/MPI_T_init_thread.3.rst index 3b6e6a5eff3..28a406a36e4 100644 --- a/docs/man-openmpi/man3/MPI_T_init_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_T_init_thread.3.rst @@ -5,7 +5,7 @@ MPI_T_init_thread .. include_body -:ref:`MPI_T_init_thread` - Initializes the MPI Tool information interface +:ref:`MPI_T_init_thread` |mdash| Initializes the MPI Tool information interface SYNTAX ------ diff --git a/docs/man-openmpi/man3/MPI_T_pvar_get_info.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_get_info.3.rst index baddfc6343d..3192bfa8312 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_get_info.3.rst @@ -6,7 +6,7 @@ MPI_T_pvar_get_info .. include_body -:ref:`MPI_T_pvar_get_info` - Query information from a performance variable +:ref:`MPI_T_pvar_get_info` |mdash| Query information from a performance variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_pvar_get_num.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_get_num.3.rst index 06af21fbcda..4f453bba636 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_get_num.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_get_num.3.rst @@ -6,7 +6,7 @@ MPI_T_pvar_get_num .. include_body -:ref:`MPI_T_pvar_get_num` - Query the number of performance variables +:ref:`MPI_T_pvar_get_num` |mdash| Query the number of performance variables SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_pvar_read.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_read.3.rst index 39f147b8684..a22e9f17a50 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_read.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_read.3.rst @@ -6,7 +6,7 @@ MPI_T_pvar_read .. include_body -:ref:`MPI_T_pvar_read` - Read the value of a performance variable +:ref:`MPI_T_pvar_read` |mdash| Read the value of a performance variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_pvar_readreset.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_readreset.3.rst index ddefa503f9c..3633d13ea1b 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_readreset.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_readreset.3.rst @@ -6,7 +6,7 @@ MPI_T_pvar_readreset .. include_body -:ref:`MPI_T_pvar_readreset` - Atomically read and reset the value of a +:ref:`MPI_T_pvar_readreset` |mdash| Atomically read and reset the value of a performance variable diff --git a/docs/man-openmpi/man3/MPI_T_pvar_reset.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_reset.3.rst index 512f2a8a45f..b016c7738db 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_reset.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_reset.3.rst @@ -6,7 +6,7 @@ MPI_T_pvar_reset .. include_body -:ref:`MPI_T_pvar_reset` - Reset the value of a performance variable +:ref:`MPI_T_pvar_reset` |mdash| Reset the value of a performance variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_T_pvar_write.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_write.3.rst index bdbd4ebb7a4..b029e3ec044 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_write.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_write.3.rst @@ -6,7 +6,7 @@ MPI_T_pvar_write .. include_body -:ref:`MPI_T_pvar_write` - Write the value of a control variable +:ref:`MPI_T_pvar_write` |mdash| Write the value of a control variable SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Test.3.rst b/docs/man-openmpi/man3/MPI_Test.3.rst index 5c181bb11b7..6091da51148 100644 --- a/docs/man-openmpi/man3/MPI_Test.3.rst +++ b/docs/man-openmpi/man3/MPI_Test.3.rst @@ -6,7 +6,7 @@ MPI_Test .. include_body -:ref:`MPI_Test` - Tests for the completion of a specific send or receive. +:ref:`MPI_Test` |mdash| Tests for the completion of a specific send or receive. SYNTAX @@ -70,10 +70,12 @@ false, otherwise. In this case, the value of the status object is undefined. :ref:`MPI_Test` is a local operation. The return status object for a receive operation carries information -that can be accessed as described in Section 3.2.5 of the MPI-1 -Standard, "Return Status." The status object for a send operation -carries information that can be accessed by a call to :ref:`MPI_Test_cancelled` -(see Section 3.8 of the MPI-1 Standard, "Probe and Cancel"). +that can be accessed as described in the "Return Status" subsection of +the "Point-to-Point Communication" chapter in the `MPI Standard +`_. The status object for a send +operation carries information that can be accessed by a call to +:ref:`MPI_Test_cancelled` (see the "Probe and Cancel" section of the +`MPI Standard `_). If your application does not need to examine the *status* field, you can save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a @@ -101,12 +103,15 @@ ERRORS .. include:: ./ERRORS.rst -Note that per MPI-1 section 3.2.5, MPI errors on requests passed to -:ref:`MPI_TEST` do not set the status.MPI_ERROR field in the returned status. -The error code is passed to the back-end error handler and may be passed -back to the caller through the return value of :ref:`MPI_TEST` if the back-end -error handler returns it. The pre-defined MPI error handler -MPI_ERRORS_RETURN exhibits this behavior, for example. +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on requests passed to +:ref:`MPI_TEST` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_TEST` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst b/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst index 443bb00b4f4..b3dd9b95f42 100644 --- a/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst +++ b/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst @@ -6,7 +6,7 @@ MPI_Test_cancelled .. include_body -:ref:`MPI_Test_cancelled` - Tests whether a request was canceled. +:ref:`MPI_Test_cancelled` |mdash| Tests whether a request was canceled. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Testall.3.rst b/docs/man-openmpi/man3/MPI_Testall.3.rst index d675e0d7e4f..8937c06aee9 100644 --- a/docs/man-openmpi/man3/MPI_Testall.3.rst +++ b/docs/man-openmpi/man3/MPI_Testall.3.rst @@ -6,7 +6,7 @@ MPI_Testall .. include_body -:ref:`MPI_Testall` - Tests for the completion of all previously initiated +:ref:`MPI_Testall` |mdash| Tests for the completion of all previously initiated communications in a list. @@ -101,17 +101,17 @@ ERRORS .. include:: ./ERRORS.rst -For each invocation of :ref:`MPI_Testall`, if one or more requests generate an -MPI error, only the *first* MPI request that caused an error will be -passed to its corresponding error handler. No other error handlers will -be invoked (even if multiple requests generated errors). However, *all* -requests that generate an error will have a relevant error code set in -the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was -used). - -If the invoked error handler allows :ref:`MPI_Testall` to return to the caller, -the value MPI_ERR_IN_STATUS will be returned in the C and Fortran -bindings. +For each invocation of :ref:`MPI_Testall`, if one or more requests +generate an MPI error, only the *first* MPI request that caused an +error will be passed to its corresponding error handler. No other +error handlers will be invoked (even if multiple requests generated +errors). However, *all* requests that generate an error will have a +relevant error code set in the corresponding ``status.MPI_ERROR`` +field (unless ``MPI_STATUSES_IGNORE`` was used). + +If the invoked error handler allows :ref:`MPI_Testall` to return to +the caller, the value ``MPI_ERR_IN_STATUS`` will be returned in the C +and Fortran bindings. .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Testany.3.rst b/docs/man-openmpi/man3/MPI_Testany.3.rst index b10bf7ff428..0d799ed0ae1 100644 --- a/docs/man-openmpi/man3/MPI_Testany.3.rst +++ b/docs/man-openmpi/man3/MPI_Testany.3.rst @@ -6,7 +6,7 @@ MPI_Testany .. include_body -:ref:`MPI_Testany` - Tests for completion of any one previously initiated +:ref:`MPI_Testany` |mdash| Tests for completion of any one previously initiated communication in a list. @@ -101,12 +101,15 @@ ERRORS .. include:: ./ERRORS.rst -Note that per MPI-1 section 3.2.5, MPI errors on requests passed to -:ref:`MPI_TESTANY` do not set the ``status.MPI_ERROR`` field in the returned -status. The error code is passed to the back-end error handler and may -be passed back to the caller through the return value of :ref:`MPI_TESTANY` if -the back-end error handler returns it. The pre-defined MPI error handler -``MPI_ERRORS_RETURN`` exhibits this behavior, for example. +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on requests passed to +:ref:`MPI_TESTANY` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_TESTANY` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. .. seealso:: * :ref:`MPI_Comm_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Testsome.3.rst b/docs/man-openmpi/man3/MPI_Testsome.3.rst index 59e38716eed..52205f2cca6 100644 --- a/docs/man-openmpi/man3/MPI_Testsome.3.rst +++ b/docs/man-openmpi/man3/MPI_Testsome.3.rst @@ -6,7 +6,7 @@ MPI_Testsome .. include_body -:ref:`MPI_Testsome` - Tests for completion of one or more previously +:ref:`MPI_Testsome` |mdash| Tests for completion of one or more previously initiated communications in a list. @@ -124,17 +124,17 @@ ERRORS .. include:: ./ERRORS.rst -For each invocation of :ref:`MPI_Testsome`, if one or more requests generate an -MPI error, only the *first* MPI request that caused an error will be -passed to its corresponding error handler. No other error handlers will -be invoked (even if multiple requests generated errors). However, *all* -requests that generate an error will have a relevant error code set in -the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was -used). - -If the invoked error handler allows :ref:`MPI_Testsome` to return to the -caller, the value MPI_ERR_IN_STATUS will be returned in the C and -Fortran bindings. +For each invocation of :ref:`MPI_Testsome`, if one or more requests +generate an MPI error, only the *first* MPI request that caused an +error will be passed to its corresponding error handler. No other +error handlers will be invoked (even if multiple requests generated +errors). However, *all* requests that generate an error will have a +relevant error code set in the corresponding ``status.MPI_ERROR`` +field (unless ``MPI_STATUSES_IGNORE`` was used). + +If the invoked error handler allows :ref:`MPI_Testsome` to return to +the caller, the value ``MPI_ERR_IN_STATUS`` will be returned in the C +and Fortran bindings. .. seealso:: * :ref:`MPI_Comm_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Topo_test.3.rst b/docs/man-openmpi/man3/MPI_Topo_test.3.rst index 4dbee255825..1f9896ce5d1 100644 --- a/docs/man-openmpi/man3/MPI_Topo_test.3.rst +++ b/docs/man-openmpi/man3/MPI_Topo_test.3.rst @@ -6,7 +6,7 @@ MPI_Topo_test .. include_body -:ref:`MPI_Topo_test` - Determines the type of topology (if any) associated +:ref:`MPI_Topo_test` |mdash| Determines the type of topology (if any) associated with a communicator. diff --git a/docs/man-openmpi/man3/MPI_Type_commit.3.rst b/docs/man-openmpi/man3/MPI_Type_commit.3.rst index 2dcd135a02a..83125e4eaa7 100644 --- a/docs/man-openmpi/man3/MPI_Type_commit.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_commit.3.rst @@ -6,7 +6,7 @@ MPI_Type_commit .. include_body -:ref:`MPI_Type_commit` - Commits a data type. +:ref:`MPI_Type_commit` |mdash| Commits a data type. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst b/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst index f5d2cb54279..518cf82466a 100644 --- a/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst @@ -6,7 +6,7 @@ MPI_Type_contiguous .. include_body -:ref:`MPI_Type_contiguous` - Creates a contiguous datatype. +:ref:`MPI_Type_contiguous` |mdash| Creates a contiguous datatype. SYNTAX @@ -96,8 +96,8 @@ defined by: disp(n-1) + ex), ...,(type(0), disp(0) + ex * (count - 1)), ...,(type(n-1), disp(n-1) + ex * (count - 1))}. -For more information about derived datatypes, see Section 3.12 of the -MPI-1 Standard. +For more information about derived datatypes, see the Datatypes +chapter in the `MPI Standard `_. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst b/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst index 39197dee2cd..1ddbc6d5694 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst @@ -6,7 +6,7 @@ MPI_Type_create_darray .. include_body -:ref:`MPI_Type_create_darray` - Creates a distributed array datatype; +:ref:`MPI_Type_create_darray` |mdash| Creates a distributed array datatype; SYNTAX @@ -93,7 +93,7 @@ For a call to :ref:`MPI_Type_create_darray` to be correct, the equation must be satisfied. The ordering of processes in the process grid is assumed to be row-major, as in the case of virtual Cartesian process -topologies in MPI-1. +topologies in the `MPI Standard `_. Each dimension of the array can be distributed in one of three ways: @@ -150,10 +150,10 @@ NOTES For both Fortran and C arrays, the ordering of processes in the process grid is assumed to be row-major. This is consistent with the ordering -used in virtual Cartesian process topologies in MPI-1. To create such +used in virtual Cartesian process topologies in MPI. To create such virtual process topologies, or to find the coordinates of a process in the process grid, etc., users may use the corresponding functions -provided in MPI-1. +provided in MPI. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Type_create_hindexed.3.rst b/docs/man-openmpi/man3/MPI_Type_create_hindexed.3.rst index cd4deaf2544..7cdafbe8a5b 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_hindexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_hindexed.3.rst @@ -5,7 +5,7 @@ MPI_Type_create_hindexed .. include_body -:ref:`MPI_Type_create_hindexed` - Creates an indexed datatype with offsets in bytes. +:ref:`MPI_Type_create_hindexed` |mdash| Creates an indexed datatype with offsets in bytes. SYNTAX @@ -41,7 +41,7 @@ Fortran Syntax INPUT PARAMETERS ---------------- -* ``count``: Number of blocks -- also number of entries in array_of_displacements and array_of_blocklengths (integer). +* ``count``: Number of blocks |mdash| also number of entries in array_of_displacements and array_of_blocklengths (integer). * ``array_of_blocklengths``: Number of elements in each block (array of nonnegative integers). * ``array_of_displacements``: Byte displacement of each block (C: array of *MPI_Aint*, Fortran: array of integer). * ``oldtype``: Old datatype (handle). diff --git a/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst b/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst index 0d00b292c90..adcecceaec2 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst @@ -6,7 +6,7 @@ MPI_Type_create_hvector .. include_body -:ref:`MPI_Type_create_hvector` - Creates a vector (strided) data type with offset in bytes. +:ref:`MPI_Type_create_hvector` |mdash| Creates a vector (strided) data type with offset in bytes. SYNTAX @@ -73,8 +73,9 @@ in bytes. This routine replaces :ref:`MPI_Type_hvector`, which is deprecated. The function :ref:`MPI_Type_create_hvector` is identical to :ref:`MPI_Type_vector`, except that stride is given in bytes, rather than in elements. The use for both -types of vector constructors is illustrated in the examples in Section -3.12.7 of the MPI-1 Standard. +types of vector constructors is illustrated in the examples in the +Datatype chapter of the `MPI Standard +`_. Assume that oldtype has type map diff --git a/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst b/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst index e51c66087b1..cbc12cf909c 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst @@ -6,7 +6,7 @@ MPI_Type_create_keyval .. include_body -:ref:`MPI_Type_create_keyval` - Generates a new attribute key for caching +:ref:`MPI_Type_create_keyval` |mdash| Generates a new attribute key for caching on data types. diff --git a/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst b/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst index 08dba0ced43..325dec36a33 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst @@ -6,7 +6,7 @@ MPI_Type_create_resized .. include_body -:ref:`MPI_Type_create_resized` - Returns a new data type with new extent +:ref:`MPI_Type_create_resized` |mdash| Returns a new data type with new extent and upper and lower bounds. @@ -77,7 +77,7 @@ of the data type when used in communication operations, with *count* > NOTE ---- -Use of :ref:`MPI_Type_create_resized` is strongly recommended over the old +Use of :ref:`MPI_Type_create_resized` is strongly recommended over the legacy MPI-1 functions :ref:`MPI_Type_extent` and :ref:`MPI_Type_lb`. diff --git a/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst b/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst index a5a61102776..1d22e982716 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst @@ -6,7 +6,7 @@ MPI_Type_create_struct .. include_body -:ref:`MPI_Type_create_struct` - Creates a structured data type. +:ref:`MPI_Type_create_struct` |mdash| Creates a structured data type. SYNTAX @@ -57,7 +57,7 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``count``: Number of blocks (integer) -- also number of entries in arrays *array_of_types*, *array_of_displacements*, and *array_of_blocklengths*. +* ``count``: Number of blocks (integer) |mdash| also number of entries in arrays *array_of_types*, *array_of_displacements*, and *array_of_blocklengths*. * ``array_of_blocklengths``: Number of elements in each block (array of integers). * ``array_of_displacements``: Byte displacement of each block (array of integers). * ``array_of_types``: Type of elements in each block (array of handles to data-type objects). diff --git a/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst b/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst index c48194044f4..fb4d8aeae17 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst @@ -6,7 +6,7 @@ MPI_Type_create_subarray .. include_body -:ref:`MPI_Type_create_subarray` - Creates a data type describing an +:ref:`MPI_Type_create_subarray` |mdash| Creates a data type describing an *n*-dimensional subarray of an *n*-dimensional array. diff --git a/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst b/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst index 81d8645e627..1f5e20fa22c 100644 --- a/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst @@ -6,7 +6,7 @@ MPI_Type_delete_attr .. include_body -:ref:`MPI_Type_delete_attr` - Deletes a datatype-caching attribute value +:ref:`MPI_Type_delete_attr` |mdash| Deletes a datatype-caching attribute value associated with a key. diff --git a/docs/man-openmpi/man3/MPI_Type_dup.3.rst b/docs/man-openmpi/man3/MPI_Type_dup.3.rst index 6aefa2d514a..48c046c538b 100644 --- a/docs/man-openmpi/man3/MPI_Type_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_dup.3.rst @@ -6,7 +6,7 @@ MPI_Type_dup .. include_body -:ref:`MPI_Type_dup` - Duplicates a data type with associated key values. +:ref:`MPI_Type_dup` |mdash| Duplicates a data type with associated key values. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_extent.3.rst index f68c1c98f5e..e3d5bb2ec73 100644 --- a/docs/man-openmpi/man3/MPI_Type_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_extent.3.rst @@ -6,7 +6,7 @@ MPI_Type_extent .. include_body -:ref:`MPI_Type_extent` - Returns the extent of a data type -- |deprecated_favor| :ref:`MPI_Type_get_extent`. +:ref:`MPI_Type_extent` |mdash| Returns the extent of a data type |mdash| |deprecated_favor| :ref:`MPI_Type_get_extent`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_free.3.rst b/docs/man-openmpi/man3/MPI_Type_free.3.rst index 91d48d250c9..c68cb4a16b2 100644 --- a/docs/man-openmpi/man3/MPI_Type_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_free.3.rst @@ -6,7 +6,7 @@ MPI_Type_free .. include_body -:ref:`MPI_Type_free` - Frees a data type. +:ref:`MPI_Type_free` |mdash| Frees a data type. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst b/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst index 811e27fa847..672daf1ccde 100644 --- a/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst @@ -6,7 +6,7 @@ MPI_Type_free_keyval .. include_body -:ref:`MPI_Type_free_keyval` - Frees a previously created type key value. +:ref:`MPI_Type_free_keyval` |mdash| Frees a previously created type key value. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst b/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst index 9097b2ed92e..b9793fadb4b 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst @@ -6,7 +6,7 @@ MPI_Type_get_attr .. include_body -:ref:`MPI_Type_get_attr` - Returns the attribute associated with a data +:ref:`MPI_Type_get_attr` |mdash| Returns the attribute associated with a data type. diff --git a/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst b/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst index 0e266bf5e15..8f13f5fd506 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst @@ -6,7 +6,7 @@ MPI_Type_get_contents .. include_body -:ref:`MPI_Type_get_contents` - Returns information about arguments used in +:ref:`MPI_Type_get_contents` |mdash| Returns information about arguments used in creation of a data type. @@ -107,17 +107,18 @@ of attributes of returned data types is undefined. Note that :ref:`MPI_Type_get_contents` can be invoked with a data-type argument that was constructed using :ref:`MPI_Type_create_f90_real`, :ref:`MPI_Type_create_f90_integer`, or :ref:`MPI_Type_create_f90_complex` (an unnamed -predefined data type). In such a case, an empty *array_of_datatypes is -returned.* +predefined data type). In such a case, an empty *array_of_datatypes* is +returned. -In the MPI-1 data-type constructor calls, the address arguments in -Fortran are of type INTEGER. In the new MPI-2 calls, the address -arguments are of type INTEGER(KIND=MPI_ADDRESS_KIND). The call +In the legacy MPI-1 datatype constructor calls, the address arguments in +Fortran are of type ``INTEGER``. In subsequent versions of the `MPI +Standard `_, the address +arguments are of type ``INTEGER(KIND=MPI_ADDRESS_KIND)``. The call :ref:`MPI_Type_get_contents` returns all addresses in an argument of type -INTEGER(KIND=MPI_ADDRESS_KIND). This is true even if the old MPI-1 calls +``INTEGER(KIND=MPI_ADDRESS_KIND)``. This is true even if the old MPI-1 calls were used. Thus, the location of values returned can be thought of as being returned by the C bindings. It can also be determined by examining -the new MPI-2 calls for data-type constructors for the deprecated MPI-1 +the current MPI calls for datatype constructors for the deprecated MPI-1 calls that involve addresses. diff --git a/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst b/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst index 9a38d613a31..1663ae4acf6 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst @@ -6,7 +6,7 @@ MPI_Type_get_envelope .. include_body -:ref:`MPI_Type_get_envelope` - Returns information about input arguments +:ref:`MPI_Type_get_envelope` |mdash| Returns information about input arguments associated with a data type. diff --git a/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst index 6a133963994..54801689ffa 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst @@ -81,7 +81,7 @@ MPI_UNDEFINED. NOTE ---- -Use of :ref:`MPI_Type_get_extent` is strongly recommended over the old MPI-1 +Use of :ref:`MPI_Type_get_extent` is strongly recommended over the legacy MPI-1 functions :ref:`MPI_Type_extent` and :ref:`MPI_Type_lb`. diff --git a/docs/man-openmpi/man3/MPI_Type_get_name.3.rst b/docs/man-openmpi/man3/MPI_Type_get_name.3.rst index 5b3ee5f09dd..88114a6e358 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_name.3.rst @@ -6,7 +6,7 @@ MPI_Type_get_name .. include_body -:ref:`MPI_Type_get_name` - Gets the name of a data type. +:ref:`MPI_Type_get_name` |mdash| Gets the name of a data type. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst index 729182e8e6c..9e7b956844d 100644 --- a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst @@ -6,7 +6,7 @@ MPI_Type_hindexed .. include_body -:ref:`MPI_Type_hindexed` - Creates an indexed datatype with offsets in bytes -- |deprecated_favor| :ref:`MPI_Type_create_hindexed`. +:ref:`MPI_Type_hindexed` |mdash| Creates an indexed datatype with offsets in bytes |mdash| |deprecated_favor| :ref:`MPI_Type_create_hindexed`. SYNTAX @@ -42,7 +42,7 @@ Fortran Syntax INPUT PARAMETERS ---------------- -* ``count``: Number of blocks -- also number of entries in array_of_displacements and array_of_blocklengths (integer). +* ``count``: Number of blocks |mdash| also number of entries in array_of_displacements and array_of_blocklengths (integer). * ``array_of_blocklengths``: Number of elements in each block (array of nonnegative integers). * ``array_of_displacements``: Byte displacement of each block (C: array of *MPI_Aint*, Fortran: array of integer). * ``oldtype``: Old datatype (handle). diff --git a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst index 12fcb8cdf12..1546c16d457 100644 --- a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst @@ -6,7 +6,7 @@ MPI_Type_hvector .. include_body -:ref:`MPI_Type_hvector` - Creates a vector (strided) datatype with offset in bytes -- |deprecated_favor| :ref:`MPI_Type_create_hvector`. +:ref:`MPI_Type_hvector` |mdash| Creates a vector (strided) datatype with offset in bytes |mdash| |deprecated_favor| :ref:`MPI_Type_create_hvector`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_indexed.3.rst b/docs/man-openmpi/man3/MPI_Type_indexed.3.rst index 3f500104957..b6ada03096c 100644 --- a/docs/man-openmpi/man3/MPI_Type_indexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_indexed.3.rst @@ -78,7 +78,7 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``count``: Number of blocks -- also number of entries in array_of_displacements and array_of_blocklengths (nonnegative integer). +* ``count``: Number of blocks |mdash| also number of entries in array_of_displacements and array_of_blocklengths (nonnegative integer). * ``array_of_blocklengths``: Number of elements per block (array of nonnegative integers). * ``array_of_displacements``: Displacement for each block, in multiples of oldtype extent for MPI_Type_indexed and bytes for MPI_Type_create_hindexed (array of integer for **MPI_TYPE_INDEXED**, array of *MPI_Aint* for **MPI_TYPE_CREATE_HINDEXED**). * ``oldtype``: Old datatype (handle). diff --git a/docs/man-openmpi/man3/MPI_Type_lb.3.rst b/docs/man-openmpi/man3/MPI_Type_lb.3.rst index 33f904cbdb3..3f3fecb1aa2 100644 --- a/docs/man-openmpi/man3/MPI_Type_lb.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_lb.3.rst @@ -6,7 +6,7 @@ MPI_Type_lb .. include_body -:ref:`MPI_Type_lb` - Returns the lower bound of a data type -- |deprecated_favor| :ref:`MPI_Type_get_extent`. +:ref:`MPI_Type_lb` |mdash| Returns the lower bound of a data type |mdash| |deprecated_favor| :ref:`MPI_Type_get_extent`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_match_size.3.rst b/docs/man-openmpi/man3/MPI_Type_match_size.3.rst index 9c891e18e70..331e964678a 100644 --- a/docs/man-openmpi/man3/MPI_Type_match_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_match_size.3.rst @@ -6,7 +6,7 @@ MPI_Type_match_size .. include_body -:ref:`MPI_Type_match_size` - Returns an MPI datatype of a given type and +:ref:`MPI_Type_match_size` |mdash| Returns an MPI datatype of a given type and size diff --git a/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst b/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst index f79086688aa..aa8743cf66a 100644 --- a/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst @@ -6,7 +6,7 @@ MPI_Type_set_attr .. include_body -:ref:`MPI_Type_set_attr` - Sets a key value/attribute pair to a data type. +:ref:`MPI_Type_set_attr` |mdash| Sets a key value/attribute pair to a data type. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_set_name.3.rst b/docs/man-openmpi/man3/MPI_Type_set_name.3.rst index 35d31617a0b..becb22ffd11 100644 --- a/docs/man-openmpi/man3/MPI_Type_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_set_name.3.rst @@ -6,7 +6,7 @@ MPI_Type_set_name .. include_body -:ref:`MPI_Type_set_name` - Sets the name of a data type. +:ref:`MPI_Type_set_name` |mdash| Sets the name of a data type. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_struct.3.rst b/docs/man-openmpi/man3/MPI_Type_struct.3.rst index 80e97c6015e..0b931741a7e 100644 --- a/docs/man-openmpi/man3/MPI_Type_struct.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_struct.3.rst @@ -6,7 +6,7 @@ MPI_Type_struct .. include_body -:ref:`MPI_Type_struct` - Creates a *struct* data type -- |deprecated_favor| :ref:`MPI_Type_create_struct`. +:ref:`MPI_Type_struct` |mdash| Creates a *struct* data type |mdash| |deprecated_favor| :ref:`MPI_Type_create_struct`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_ub.3.rst b/docs/man-openmpi/man3/MPI_Type_ub.3.rst index 0fe9de18936..7f7e970d1a9 100644 --- a/docs/man-openmpi/man3/MPI_Type_ub.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_ub.3.rst @@ -6,7 +6,7 @@ MPI_Type_ub .. include_body -:ref:`MPI_Type_ub` - Returns the upper bound of a datatype -- |deprecated_favor| :ref:`MPI_Type_get_extent`. +:ref:`MPI_Type_ub` |mdash| Returns the upper bound of a datatype |mdash| |deprecated_favor| :ref:`MPI_Type_get_extent`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Type_vector.3.rst b/docs/man-openmpi/man3/MPI_Type_vector.3.rst index 7f283b03613..b335513947a 100644 --- a/docs/man-openmpi/man3/MPI_Type_vector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_vector.3.rst @@ -6,7 +6,7 @@ MPI_Type_vector .. include_body -:ref:`MPI_Type_vector` - Creates a vector (strided) datatype. +:ref:`MPI_Type_vector` |mdash| Creates a vector (strided) datatype. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Unpack.3.rst b/docs/man-openmpi/man3/MPI_Unpack.3.rst index c73b65cc393..5ba9444edd4 100644 --- a/docs/man-openmpi/man3/MPI_Unpack.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpack.3.rst @@ -6,7 +6,7 @@ MPI_Unpack .. include_body -:ref:`MPI_Unpack` - Unpacks a datatype into contiguous memory. +:ref:`MPI_Unpack` |mdash| Unpacks a datatype into contiguous memory. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Unpack_external.3.rst b/docs/man-openmpi/man3/MPI_Unpack_external.3.rst index 6e59b233cd2..5271292f58e 100644 --- a/docs/man-openmpi/man3/MPI_Unpack_external.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpack_external.3.rst @@ -6,7 +6,7 @@ MPI_Unpack_external .. include_body -:ref:`MPI_Unpack_external` - Reads data from a portable format +:ref:`MPI_Unpack_external` |mdash| Reads data from a portable format SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Wait.3.rst b/docs/man-openmpi/man3/MPI_Wait.3.rst index fdeb46002db..91f1631d638 100644 --- a/docs/man-openmpi/man3/MPI_Wait.3.rst +++ b/docs/man-openmpi/man3/MPI_Wait.3.rst @@ -6,7 +6,7 @@ MPI_Wait .. include_body -:ref:`MPI_Wait` - Waits for an MPI send or receive to complete. +:ref:`MPI_Wait` |mdash| Waits for an MPI send or receive to complete. SYNTAX @@ -64,12 +64,14 @@ created by a nonblocking send or receive call, then the object is deallocated by the call to :ref:`MPI_Wait` and the request handle is set to ``MPI_REQUEST_NULL``. -The call returns, in status, information on the completed operation. The -content of the status object for a receive operation can be accessed as -described in Section 3.2.5 of the MPI-1 Standard, "Return Status." The -status object for a send operation may be queried by a call to -:ref:`MPI_Test_cancelled` (see Section 3.8 of the MPI-1 Standard, "Probe and -Cancel"). +The call returns, in status, information on the completed +operation. The content of the status object for a receive operation +can be accessed as described in the "Return Status" subsection of the +"Point-to-Point Communication" chapter in the `MPI Standard +`_. The status object for a send +operation may be queried by a call to :ref:`MPI_Test_cancelled` (see +the "Probe and Cancel" section in the `MPI Standard +`_). If your application does not need to examine the *status* field, you can save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a @@ -86,8 +88,9 @@ NOTES Successful return of :ref:`MPI_Wait` after an :ref:`MPI_Ibsend` implies that the user send buffer can be reused i.e., data has been sent out or copied into a buffer attached with :ref:`MPI_Buffer_attach`. Note that, at this point, we can -no longer cancel the send (for more information, see Section 3.8 of the -MPI-1 Standard, "Probe and Cancel"). If a matching receive is never +no longer cancel the send (for more information, see the "Probe and +Cancel" section in the `MPI Standard +`_). If a matching receive is never posted, then the buffer cannot be freed. This runs somewhat counter to the stated goal of :ref:`MPI_Cancel` (always being able to free program space that was committed to the communication subsystem). @@ -113,12 +116,15 @@ ERRORS .. include:: ./ERRORS.rst -Note that per MPI-1 section 3.2.5, MPI errors on requests passed to -:ref:`MPI_WAIT` do not set the ``status.MPI_ERROR`` field in the returned status. -The error code is passed to the back-end error handler and may be passed -back to the caller through the return value of :ref:`MPI_WAIT` if the back-end -error handler returns it. The pre-defined MPI error handler -``MPI_ERRORS_RETURN`` exhibits this behavior, for example. +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on requests passed to +:ref:`MPI_WAIT` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_WAIT` if the back-end error handler returns it. The +pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Waitall.3.rst b/docs/man-openmpi/man3/MPI_Waitall.3.rst index a3cb42d0939..061797e1797 100644 --- a/docs/man-openmpi/man3/MPI_Waitall.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitall.3.rst @@ -6,7 +6,7 @@ MPI_Waitall .. include_body -:ref:`MPI_Waitall` - Waits for all given communications to complete. +:ref:`MPI_Waitall` |mdash| Waits for all given communications to complete. SYNTAX @@ -101,17 +101,17 @@ ERRORS .. include:: ./ERRORS.rst -For each invocation of :ref:`MPI_Waitall`, if one or more requests generate an -MPI error, only the *first* MPI request that caused an error will be -passed to its corresponding error handler. No other error handlers will -be invoked (even if multiple requests generated errors). However, *all* -requests that generate an error will have a relevant error code set in -the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was -used). - -If the invoked error handler allows :ref:`MPI_Waitall` to return to the caller, -the value MPI_ERR_IN_STATUS will be returned in the C and Fortran -bindings. +For each invocation of :ref:`MPI_Waitall`, if one or more requests +generate an MPI error, only the *first* MPI request that caused an +error will be passed to its corresponding error handler. No other +error handlers will be invoked (even if multiple requests generated +errors). However, *all* requests that generate an error will have a +relevant error code set in the corresponding ``status.MPI_ERROR`` +field (unless ``MPI_STATUSES_IGNORE`` was used). + +If the invoked error handler allows :ref:`MPI_Waitall` to return to +the caller, the value ``MPI_ERR_IN_STATUS`` will be returned in the C +and Fortran bindings. .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Waitany.3.rst b/docs/man-openmpi/man3/MPI_Waitany.3.rst index 0d2d72854bb..bb99c470149 100644 --- a/docs/man-openmpi/man3/MPI_Waitany.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitany.3.rst @@ -6,7 +6,7 @@ MPI_Waitany .. include_body -:ref:`MPI_Waitany` - Waits for any specified send or receive to complete. +:ref:`MPI_Waitany` |mdash| Waits for any specified send or receive to complete. SYNTAX @@ -93,7 +93,7 @@ special value for the *status* argument. CALL MPI_ISEND(a, n, MPI_REAL, 0, tag, comm, request, ierr) CALL MPI_WAIT(request, status, ierr) END DO - ELSE ! rank=0 -- server code + ELSE ! rank=0: server code DO i=1, size-1 CALL MPI_IRECV(a(1,i), n, MPI_REAL, i tag, & comm, request_list(i), ierr) @@ -112,12 +112,15 @@ ERRORS .. include:: ./ERRORS.rst -Note that per MPI-1 section 3.2.5, MPI errors on requests passed to -:ref:`MPI_WAITANY` do not set the ``status.MPI_ERROR`` field in the returned -status. The error code is passed to the back-end error handler and may -be passed back to the caller through the return value of :ref:`MPI_WAITANY` if -the back-end error handler returns it. The pre-defined MPI error handler -``MPI_ERRORS_RETURN`` exhibits this behavior, for example. +Note that per the "Return Status" section in the "Point-to-Point +Communication" chapter in the `MPI Standard +`_, MPI errors on requests passed to +:ref:`MPI_WAITANY` do not set the ``status.MPI_ERROR`` field in the +returned *status*. The error code is always passed to the back-end +error handler and may be passed back to the caller through the return +value of :ref:`MPI_WAITANY` if the back-end error handler returns it. +The pre-defined MPI error handler ``MPI_ERRORS_RETURN`` exhibits this +behavior, for example. .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Waitsome.3.rst b/docs/man-openmpi/man3/MPI_Waitsome.3.rst index f2b72b577ce..d1afadd72a2 100644 --- a/docs/man-openmpi/man3/MPI_Waitsome.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitsome.3.rst @@ -6,7 +6,7 @@ MPI_Waitsome .. include_body -:ref:`MPI_Waitsome` - Waits for some given communications to complete. +:ref:`MPI_Waitsome` |mdash| Waits for some given communications to complete. SYNTAX @@ -113,7 +113,7 @@ using :ref:`MPI_Waitsome`. CALL MPI_ISEND(a, n, MPI_REAL, 0, tag, comm, request, ierr) CALL MPI_WAIT(request, status, ierr) END DO - ELSE ! rank=0 -- server code + ELSE ! rank=0: server code DO i=1, size-1 CALL MPI_IRECV(a(1,i), n, MPI_REAL, i, tag, & comm, requests(i), ierr) @@ -142,17 +142,17 @@ ERRORS .. include:: ./ERRORS.rst -For each invocation of :ref:`MPI_Waitsome`, if one or more requests generate an -MPI error, only the *first* MPI request that caused an error will be -passed to its corresponding error handler. No other error handlers will -be invoked (even if multiple requests generated errors). However, *all* -requests that generate an error will have a relevant error code set in -the corresponding status.MPI_ERROR field (unless MPI_STATUSES_IGNORE was -used). - -If the invoked error handler allows :ref:`MPI_Waitsome` to return to the -caller, the value MPI_ERR_IN_STATUS will be returned in the C and -Fortran bindings. +For each invocation of :ref:`MPI_Waitsome`, if one or more requests +generate an MPI error, only the *first* MPI request that caused an +error will be passed to its corresponding error handler. No other +error handlers will be invoked (even if multiple requests generated +errors). However, *all* requests that generate an error will have a +relevant error code set in the corresponding ``status.MPI_ERROR`` +field (unless ``MPI_STATUSES_IGNORE`` was used). + +If the invoked error handler allows :ref:`MPI_Waitsome` to return to +the caller, the value ``MPI_ERR_IN_STATUS`` will be returned in the C +and Fortran bindings. .. seealso:: diff --git a/docs/man-openmpi/man3/MPI_Win_allocate.3.rst b/docs/man-openmpi/man3/MPI_Win_allocate.3.rst index cf54d21a577..262c6153aa9 100644 --- a/docs/man-openmpi/man3/MPI_Win_allocate.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_allocate.3.rst @@ -6,7 +6,7 @@ MPI_Win_allocate .. include_body -:ref:`MPI_Win_allocate` - One-sided MPI call that allocates memory and +:ref:`MPI_Win_allocate` |mdash| One-sided MPI call that allocates memory and returns a window object for RMA operations. diff --git a/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst b/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst index 86fd9bbcadf..357e405c119 100644 --- a/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst @@ -6,7 +6,7 @@ MPI_Win_allocate_shared .. include_body -:ref:`MPI_Win_allocate_shared` - One-sided MPI call that allocates shared +:ref:`MPI_Win_allocate_shared` |mdash| One-sided MPI call that allocates shared memory and returns a window object for RMA operations. diff --git a/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst index 10ba9307082..c06e0cb0c1d 100644 --- a/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Win_call_errhandler .. include_body -:ref:`MPI_Win_call_errhandler` - Passes the supplied error code to the +:ref:`MPI_Win_call_errhandler` |mdash| Passes the supplied error code to the error handler assigned to a window diff --git a/docs/man-openmpi/man3/MPI_Win_complete.3.rst b/docs/man-openmpi/man3/MPI_Win_complete.3.rst index 19b2c562942..3cf3c4c40f0 100644 --- a/docs/man-openmpi/man3/MPI_Win_complete.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_complete.3.rst @@ -6,7 +6,7 @@ MPI_Win_complete .. include_body -:ref:`MPI_Win_complete` - Completes an RMA access epoch on *win* started by +:ref:`MPI_Win_complete` |mdash| Completes an RMA access epoch on *win* started by a call to :ref:`MPI_Win_start` diff --git a/docs/man-openmpi/man3/MPI_Win_create.3.rst b/docs/man-openmpi/man3/MPI_Win_create.3.rst index 4ed28fb2159..0400475a8d8 100644 --- a/docs/man-openmpi/man3/MPI_Win_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create.3.rst @@ -6,7 +6,7 @@ MPI_Win_create .. include_body -:ref:`MPI_Win_create` - One-sided MPI call that returns a window object for +:ref:`MPI_Win_create` |mdash| One-sided MPI call that returns a window object for RMA operations. diff --git a/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst b/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst index 9163e06fec6..dd3546b7c93 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst @@ -6,7 +6,7 @@ MPI_Win_create_dynamic .. include_body -:ref:`MPI_Win_create_dynamic` - One-sided MPI call that returns a window +:ref:`MPI_Win_create_dynamic` |mdash| One-sided MPI call that returns a window object for RMA operations. diff --git a/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst index f0ad516bfb8..6fef09c40d3 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Win_create_errhandler .. include_body -:ref:`MPI_Win_create_errhandler` - Creates an error handler for a window. +:ref:`MPI_Win_create_errhandler` |mdash| Creates an error handler for a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst b/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst index 3f9be981f7c..3d7f852eea9 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst @@ -6,7 +6,7 @@ MPI_Win_create_keyval .. include_body -:ref:`MPI_Win_create_keyval` - Creates a keyval for a window. +:ref:`MPI_Win_create_keyval` |mdash| Creates a keyval for a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst b/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst index 60ae4c26b45..8df3676de5e 100644 --- a/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst @@ -6,7 +6,7 @@ MPI_Win_delete_attr .. include_body -:ref:`MPI_Win_delete_attr` - Deletes an attribute from a window. +:ref:`MPI_Win_delete_attr` |mdash| Deletes an attribute from a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_fence.3.rst b/docs/man-openmpi/man3/MPI_Win_fence.3.rst index 99af4bf9b47..67a8fb9003c 100644 --- a/docs/man-openmpi/man3/MPI_Win_fence.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_fence.3.rst @@ -6,7 +6,7 @@ MPI_Win_fence .. include_body -:ref:`MPI_Win_fence` - Synchronizes RMA calls on a window. +:ref:`MPI_Win_fence` |mdash| Synchronizes RMA calls on a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_free.3.rst b/docs/man-openmpi/man3/MPI_Win_free.3.rst index 9f8829392dc..43a2b59180c 100644 --- a/docs/man-openmpi/man3/MPI_Win_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_free.3.rst @@ -6,7 +6,7 @@ MPI_Win_free .. include_body -:ref:`MPI_Win_free` - Frees the window object and returns a null handle. +:ref:`MPI_Win_free` |mdash| Frees the window object and returns a null handle. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst b/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst index 431454e23d0..b39352078ee 100644 --- a/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst @@ -6,7 +6,7 @@ MPI_Win_free_keyval .. include_body -:ref:`MPI_Win_free_keyval` - Frees a window keyval. +:ref:`MPI_Win_free_keyval` |mdash| Frees a window keyval. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst b/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst index cab978ff857..eab66a6e381 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst @@ -6,7 +6,7 @@ MPI_Win_get_attr .. include_body -:ref:`MPI_Win_get_attr` - Obtains the value of a window attribute. +:ref:`MPI_Win_get_attr` |mdash| Obtains the value of a window attribute. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst index a0ad705479e..efdc8eea4e6 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Win_get_errhandler .. include_body -:ref:`MPI_Win_get_errhandler` - Retrieves the error handler currently +:ref:`MPI_Win_get_errhandler` |mdash| Retrieves the error handler currently associated with a window. diff --git a/docs/man-openmpi/man3/MPI_Win_get_group.3.rst b/docs/man-openmpi/man3/MPI_Win_get_group.3.rst index db5c8821394..3bdb299798c 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_group.3.rst @@ -6,7 +6,7 @@ MPI_Win_get_group .. include_body -:ref:`MPI_Win_get_group` - Returns a duplicate of the group of the +:ref:`MPI_Win_get_group` |mdash| Returns a duplicate of the group of the communicator used to create the window. diff --git a/docs/man-openmpi/man3/MPI_Win_get_info.3.rst b/docs/man-openmpi/man3/MPI_Win_get_info.3.rst index c5699f3873d..258349c6f17 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_info.3.rst @@ -6,7 +6,7 @@ MPI_Win_get_info .. include_body -:ref:`MPI_Win_get_info` - Retrieves active window info hints +:ref:`MPI_Win_get_info` |mdash| Retrieves active window info hints SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_get_name.3.rst b/docs/man-openmpi/man3/MPI_Win_get_name.3.rst index 0e1492fe055..72d37c1e798 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_name.3.rst @@ -6,7 +6,7 @@ MPI_Win_get_name .. include_body -:ref:`MPI_Win_get_name` - Obtains the name of a window. +:ref:`MPI_Win_get_name` |mdash| Obtains the name of a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_lock.3.rst b/docs/man-openmpi/man3/MPI_Win_lock.3.rst index 55bcc1071d8..221d2fb580e 100644 --- a/docs/man-openmpi/man3/MPI_Win_lock.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_lock.3.rst @@ -6,7 +6,7 @@ MPI_Win_lock .. include_body -:ref:`MPI_Win_lock` - Starts an RMA access epoch locking access to a +:ref:`MPI_Win_lock` |mdash| Starts an RMA access epoch locking access to a particular rank. diff --git a/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst b/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst index 4b33d419c4e..efe8a4972c4 100644 --- a/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst @@ -6,7 +6,7 @@ MPI_Win_lock_all .. include_body -:ref:`MPI_Win_lock_all` - Starts an RMA access epoch locking access to all +:ref:`MPI_Win_lock_all` |mdash| Starts an RMA access epoch locking access to all processes in the window diff --git a/docs/man-openmpi/man3/MPI_Win_post.3.rst b/docs/man-openmpi/man3/MPI_Win_post.3.rst index 87f6bf6cd25..b2d1a4d480f 100644 --- a/docs/man-openmpi/man3/MPI_Win_post.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_post.3.rst @@ -6,7 +6,7 @@ MPI_Win_post .. include_body -:ref:`MPI_Win_post` - Starts an RMA exposure epoch for the local window +:ref:`MPI_Win_post` |mdash| Starts an RMA exposure epoch for the local window associated with *win* diff --git a/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst b/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst index a4f071a3f3a..ee863a68248 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst @@ -6,7 +6,7 @@ MPI_Win_set_attr .. include_body -:ref:`MPI_Win_set_attr` - Sets the value of a window attribute. +:ref:`MPI_Win_set_attr` |mdash| Sets the value of a window attribute. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst b/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst index 756ae402a3a..a59586db846 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst @@ -6,7 +6,7 @@ MPI_Win_set_errhandler .. include_body -:ref:`MPI_Win_set_errhandler` - Attaches a new error handler to a window. +:ref:`MPI_Win_set_errhandler` |mdash| Attaches a new error handler to a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_set_info.3.rst b/docs/man-openmpi/man3/MPI_Win_set_info.3.rst index 19dacdeb3b7..233e5aaaa7c 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_info.3.rst @@ -6,7 +6,7 @@ MPI_Win_set_info .. include_body -:ref:`MPI_Win_set_info` - Set window info hints +:ref:`MPI_Win_set_info` |mdash| Set window info hints SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_set_name.3.rst b/docs/man-openmpi/man3/MPI_Win_set_name.3.rst index 315cf6e78d3..de8ff0474af 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_name.3.rst @@ -6,7 +6,7 @@ MPI_Win_set_name .. include_body -:ref:`MPI_Win_set_name` - Sets the name of a window. +:ref:`MPI_Win_set_name` |mdash| Sets the name of a window. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst b/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst index a4da17bfdc5..55ae4204e4e 100644 --- a/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst @@ -6,7 +6,7 @@ MPI_Win_shared_query .. include_body -:ref:`MPI_Win_shared_query` - Query a shared memory window +:ref:`MPI_Win_shared_query` |mdash| Query a shared memory window SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_start.3.rst b/docs/man-openmpi/man3/MPI_Win_start.3.rst index bcfd738da7f..a2f536047ba 100644 --- a/docs/man-openmpi/man3/MPI_Win_start.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_start.3.rst @@ -6,7 +6,7 @@ MPI_Win_start .. include_body -:ref:`MPI_Win_start` - Starts an RMA access epoch for *win* +:ref:`MPI_Win_start` |mdash| Starts an RMA access epoch for *win* SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Win_test.3.rst b/docs/man-openmpi/man3/MPI_Win_test.3.rst index f01f006c22e..1dcfc490d1f 100644 --- a/docs/man-openmpi/man3/MPI_Win_test.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_test.3.rst @@ -6,7 +6,7 @@ MPI_Win_test .. include_body -:ref:`MPI_Win_test` - Attempts to complete an RMA exposure epoch; a +:ref:`MPI_Win_test` |mdash| Attempts to complete an RMA exposure epoch; a nonblocking version of :ref:`MPI_Win_wait` diff --git a/docs/man-openmpi/man3/MPI_Win_unlock.3.rst b/docs/man-openmpi/man3/MPI_Win_unlock.3.rst index 31c139a9a0c..fa76e621a24 100644 --- a/docs/man-openmpi/man3/MPI_Win_unlock.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_unlock.3.rst @@ -6,7 +6,7 @@ MPI_Win_unlock .. include_body -:ref:`MPI_Win_unlock` - Completes an RMA access epoch started by a call to +:ref:`MPI_Win_unlock` |mdash| Completes an RMA access epoch started by a call to :ref:`MPI_Win_lock`. diff --git a/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst b/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst index 507972bfb71..504adf49c29 100644 --- a/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst @@ -6,7 +6,7 @@ MPI_Win_unlock_all .. include_body -:ref:`MPI_Win_unlock_all` - Completes an RMA access epoch started by a call +:ref:`MPI_Win_unlock_all` |mdash| Completes an RMA access epoch started by a call to :ref:`MPI_Win_lock_all`. diff --git a/docs/man-openmpi/man3/MPI_Win_wait.3.rst b/docs/man-openmpi/man3/MPI_Win_wait.3.rst index 9449dcc95fa..4b7132bdf7a 100644 --- a/docs/man-openmpi/man3/MPI_Win_wait.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_wait.3.rst @@ -6,7 +6,7 @@ MPI_Win_wait .. include_body -:ref:`MPI_Win_wait` - Completes an RMA exposure epoch started by a call to +:ref:`MPI_Win_wait` |mdash| Completes an RMA exposure epoch started by a call to :ref:`MPI_Win_post` on *win* diff --git a/docs/man-openmpi/man3/MPI_Wtick.3.rst b/docs/man-openmpi/man3/MPI_Wtick.3.rst index 0b28c7fa0e4..82bfb4b1a27 100644 --- a/docs/man-openmpi/man3/MPI_Wtick.3.rst +++ b/docs/man-openmpi/man3/MPI_Wtick.3.rst @@ -6,7 +6,7 @@ MPI_Wtick .. include_body -:ref:`MPI_Wtick` - Returns the resolution of :ref:`MPI_Wtime`. +:ref:`MPI_Wtick` |mdash| Returns the resolution of :ref:`MPI_Wtime`. SYNTAX diff --git a/docs/man-openmpi/man3/MPI_Wtime.3.rst b/docs/man-openmpi/man3/MPI_Wtime.3.rst index a9b2a07c826..129dd92523f 100644 --- a/docs/man-openmpi/man3/MPI_Wtime.3.rst +++ b/docs/man-openmpi/man3/MPI_Wtime.3.rst @@ -6,7 +6,7 @@ MPI_Wtime .. include_body -:ref:`MPI_Wtime` - Returns an elapsed time on the calling processor. +:ref:`MPI_Wtime` |mdash| Returns an elapsed time on the calling processor. SYNTAX diff --git a/docs/man-openshmem/man1/oshmem-wrapper-compiler.1.rst b/docs/man-openshmem/man1/oshmem-wrapper-compiler.1.rst index be3dbb08de5..4599d3f49bb 100644 --- a/docs/man-openshmem/man1/oshmem-wrapper-compiler.1.rst +++ b/docs/man-openshmem/man1/oshmem-wrapper-compiler.1.rst @@ -13,7 +13,7 @@ OpenSHMEM Wrapper Compilers .. include_body -oshcc, oshcxx, oshc++, oshfort, shmemcc, shmemcxx, shmemc++, shmemfort -- OpenSHMEM wrapper compilers +oshcc, oshcxx, oshc++, oshfort, shmemcc, shmemcxx, shmemc++, shmemfort |mdash| OpenSHMEM wrapper compilers SYNTAX diff --git a/docs/news/news-v1.x.rst b/docs/news/news-v1.x.rst index bab85fbc521..b945177598c 100644 --- a/docs/news/news-v1.x.rst +++ b/docs/news/news-v1.x.rst @@ -30,7 +30,7 @@ Open MPI version 1.10.7 - Fix Fortran compilation errors by removing MPI_SIZEOF in the Fortran interfaces when the compiler does not support it - Fixes for the pre-ignore-TKR "mpi" Fortran module implementation - (i.e., for older Fortran compilers -- these problems did not exist + (i.e., for older Fortran compilers |mdash| these problems did not exist in the "mpi" module implementation for modern Fortran compilers): - Add ``PMPI_*`` interfaces - Fix typo in MPI_FILE_WRITE_AT_ALL_BEGIN interface name @@ -1544,7 +1544,7 @@ Open MPI version 1.5.2 :Date: 9 Mar 2011 - Replaced all custom topology / affinity code with initial support - for hwloc v1.1.1 (PLPA has been removed -- long live hwloc!). Note + for hwloc v1.1.1 (PLPA has been removed |mdash| long live hwloc!). Note that hwloc is bundled with Open MPI, but an external hwloc can be used, if desired. See README for more details. - Many CMake updates for Windows builds. @@ -2084,7 +2084,7 @@ Open MPI version 1.3.3 tracking down the issues. - Change the behavior of the EXTRA_STATE parameter that is passed to Fortran attribute callback functions: this value is now stored - internally in MPI -- it no longer references the original value + internally in MPI |mdash| it no longer references the original value passed by ``MPI_*_CREATE_KEYVAL``. - Allow the overriding RFC1918 and RFC3330 for the specification of "private" networks, thereby influencing Open MPI's TCP diff --git a/docs/news/news-v2.x.rst b/docs/news/news-v2.x.rst index a534c3aa5e5..896055a43b6 100644 --- a/docs/news/news-v2.x.rst +++ b/docs/news/news-v2.x.rst @@ -337,7 +337,7 @@ Open MPI version 2.1.0 bindings. Thanks to Alastair McKinstry for the bug report. - Add support for ARM v8. - Several MCA parameters now directly support MPI_T enumerator - semantics (i.e., they accept a limited set of values -- e.g., MCA + semantics (i.e., they accept a limited set of values |mdash| e.g., MCA parameters that accept boolean values). - Added ``--with-libmpi-name=`` configure option for vendor releases of Open MPI. See the README for more detail. diff --git a/docs/news/news-v4.1.x.rst b/docs/news/news-v4.1.x.rst index 8a0db887e93..dd54dd832a7 100644 --- a/docs/news/news-v4.1.x.rst +++ b/docs/news/news-v4.1.x.rst @@ -4,8 +4,71 @@ Open MPI v4.1.x series This file contains all the NEWS updates for the Open MPI v4.1.x series, in reverse chronological order. -4.1.4 -- May, 2022 ------------------- +Open MPI version 4.1.6 +---------------------- +:Date: September, 2023 + +- Fix configure issue with XCode 15. +- Update embedded PMIx to 3.2.5. PMIx 3.2.5 addresses CVE-2023-41915. + + .. note:: Prior versions of Open MPI (and their associated PMIx + implementations) are **not** impacted by this CVE, because + Open MPI never uses escalated privileges on behalf of an + unprivileged user. We are backporting this change both + because it is low risk and to avoid alarms from CVE + scanners. + +- Fix issue with buffered sends and MTL-based interfaces (Libfabric, + PSM, Portals). +- Add missing ``MPI_F_STATUS_SIZE`` to ``mpi.h``. Thanks to @jprotze for + reporting the issue. +- Update Fortran ``mpi`` module configure check to be more correct. + Thanks to Sergey Kosukhin for identifying the issue and supplying + the fix. +- Update to properly handle PMIx v>=4.2.3. Thanks to Bruno Chareyre, + Github user @sukanka, and Christof Koehler for raising the + compatibility issues and helping test the fixes. +- Fix minor issues and add some minor performance optimizations with + OFI support. +- Support the ``striping_factor`` and ``striping_unit`` MPI_Info names + recomended by the MPI standard for parallel IO. +- Fixed some minor issues with UCX support. +- Minor optimization for 0-byte MPI_Alltoallw (i.e., make it a no-op). + + +Open MPI version 4.1.5 +---------------------- +:Date: February, 2023 + +- Fix crash in one-sided applications for certain process layouts. +- Update embedded OpenPMIx to version 3.2.4 +- Fix issue building with ``ifort`` on MacOS. +- Backport patches to Libevent for CVE-2016-10195, CVE-2016-10196, and + CVE-2016-10197. Note that Open MPI's internal libevent does not + use the impacted portions of the Libevent code base. +- SHMEM improvements: + + - Fix initializer bugs in SHMEM interface. + - Fix unsigned type comparisons generating warnings. + - Fix use after clear issue in ``shmem_ds_reset``. + +- UCX improvements + + - Fix memory registration bug that could occur when UCX was built + but not selected. + - Reduce overhead of ``add_procs`` with intercommunicators. + - Enable ``multi_send_nb`` by default. + - Call ``opal_progress`` while waiting for a UCX fence to complete. + +- Fix data corruption bug in osc/rdma component. +- Fix overflow bug in alltoall collective +- Fix crash when displaying topology. +- Add some ``MPI_F_XXX`` constants that were missing from ``mpi.h``. +- coll/ucc bug fixes. + + +Open MPI version 4.1.4 +---------------------- :Date: May, 2022 - Fix possible length integer overflow in numerous non-blocking collective diff --git a/docs/release-notes/general.rst b/docs/release-notes/general.rst index ab221948fbb..e23e55cfd61 100644 --- a/docs/release-notes/general.rst +++ b/docs/release-notes/general.rst @@ -28,7 +28,7 @@ this writing: may not include support for all the devices (etc.) that you expect, especially if their support headers / libraries are installed in non-standard locations. Network interconnects are an easy example - to discuss -- Libfabric and OpenFabrics networks, for example, both + to discuss |mdash| Libfabric and OpenFabrics networks, for example, both have supplemental headers and libraries that must be found before Open MPI can build support for them. You must specify where these files are with the appropriate options to configure. See the diff --git a/docs/validate.rst b/docs/validate.rst index ddfc9b45919..ea32a11902c 100644 --- a/docs/validate.rst +++ b/docs/validate.rst @@ -28,7 +28,7 @@ helpful: of a specific component can be displayed by using an appropriate FRAMEWORK and/or COMPONENT name. * ``--level LEVEL``: - By default, ``ompi_info`` only shows "Level 1" MCA parameters -- + By default, ``ompi_info`` only shows "Level 1" MCA parameters |mdash| parameters that can affect whether MPI processes can run successfully or not (e.g., determining which network interfaces to use). The ``--level`` option will display all MCA parameters from