diff --git a/docs/conf.py b/docs/conf.py index 3e3a8d8ce33..427c6ae5fe1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -116,7 +116,11 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. import sphinx_rtd_theme -extensions = ['recommonmark', "sphinx_rtd_theme"] +extensions = [ + 'recommonmark', + "sphinx_rtd_theme", + "sphinx.ext.extlinks", +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -139,6 +143,14 @@ # so a file named "default.css" will overwrite the builtin "default.css". #html_static_path = ['_static'] + +# Short hand external links +# Allows smoother transitioning for commonly used articles and sites +extlinks = { + 'doi': ('https://doi.org/%s', '%s'), +} + + # -- Options for MAN output ------------------------------------------------- import os diff --git a/docs/features/ulfm.rst b/docs/features/ulfm.rst index ac9f169dbc8..a36df9850f0 100644 --- a/docs/features/ulfm.rst +++ b/docs/features/ulfm.rst @@ -107,7 +107,7 @@ please use: J. Dongarra: Post-failure recovery of MPI communication capability: Design and rationale. IJHPCA 27(3): 244-254 (2013).* -Available from: https://journals.sagepub.com/doi/10.1177/1094342013488238. +Available from: :doi:`10.1177/1094342013488238`. Building ULFM support in Open MPI --------------------------------- diff --git a/docs/man-openmpi/man3/ERRORS.rst b/docs/man-openmpi/man3/ERRORS.rst index 494ef532bb2..2b7e3c75ff9 100644 --- a/docs/man-openmpi/man3/ERRORS.rst +++ b/docs/man-openmpi/man3/ERRORS.rst @@ -6,47 +6,41 @@ with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before -MPI_INIT / MPI_INIT_THREAD, after MPI_FINALIZE, or when using the Sessions +:ref:`MPI_Init`/:ref:`MPI_Init_thread`, after :ref:`MPI_Finalize`, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial -error handler can be changed by calling MPI_COMM_SET_ERRHANDLER on +error handler can be changed by calling :ref:`MPI_Comm_set_errhandler` on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI -argument to mpiexec or info key to MPI_COMM_SPAWN[_MULTIPLE]. +argument to mpiexec or info key to :ref:`MPI_Comm_spawn`/:ref:`MPI_Comm_spawn_multiple`. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions. -In the sessions model, the error handler can be set during MPI_Session_init. +Open MPI includes three predefined error handlers that can be used: -Open MPI includes three predefined error handlers that can be used:: +* ``MPI_ERRORS_ARE_FATAL`` + Causes the program to abort all connected MPI processes. +* ``MPI_ERRORS_ABORT`` + An error handler that can be invoked on a communicator, + window, file, or session. When called on a communicator, it + acts as if :ref:`MPI_Abort` was called on that communicator. If + called on a window or file, acts as if :ref:`MPI_Abort` was called + on a communicator containing the group of processes in the + corresponding window or file. If called on a session, + aborts only the local process. +* ``MPI_ERRORS_RETURN`` + Returns an error code to the application. - MPI_ERRORS_ARE_FATAL: Causes the program to abort all connected MPI processes. - MPI_ERRORS_ABORT: An error handler that can be invoked on a communicator, - window, file, or session. When called on a communicator, it - acts as if MPI_ABORT was called on that communicator. If - called on a window or file, acts as if MPI_ABORT was called - on a communicator containing the group of processes in the - corresponding window or file. If called on a session, - aborts only the local process. - MPI_ERRORS_RETURN: Returns an error code to the application. +MPI applications can also implement their own error handlers by calling: -MPI applications can also implement their own error handlers. - -Custom MPI error handlers can be created by calling: -:ref:`MPI_Comm_create_errhandler(3) ` -:ref:`MPI_File_create_errhandler(3) ` -:ref:`MPI_Session_create_errhandler(3) ` -:ref:`MPI_Win_create_errhandler(3) ` - -Predefined and custom error handlers can be set by calling: -:ref:`MPI_Comm_set_errhandler(3) ` -:ref:`MPI_File_set_errhandler(3) ` -:ref:`MPI_Session_set_errhandler(3) ` -:ref:`MPI_Win_set_errhandler(3) ` +* :ref:`MPI_Comm_create_errhandler` then :ref:`MPI_Comm_set_errhandler` +* :ref:`MPI_File_create_errhandler` then :ref:`MPI_File_set_errhandler` +* :ref:`MPI_Session_create_errhandler` then :ref:`MPI_Session_set_errhandler` or at :ref:`MPI_Session_init` +* :ref:`MPI_Win_create_errhandler` then :ref:`MPI_Win_set_errhandler` Note that MPI does not guarantee that an MPI program can continue past an error. -See the MPI man page for a full list of MPI error codes. +See the :ref:`MPI man page ` for a full list of :ref:`MPI error codes `. See the Error Handling section of the MPI-|mpi_standard_version| standard for more information. diff --git a/docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst b/docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst index bde172666f1..302c478b60b 100644 --- a/docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst +++ b/docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst @@ -94,4 +94,4 @@ EXAMPLES } .. seealso:: - :ref:`MPIX_Query_rocm_support` + * :ref:`MPIX_Query_rocm_support` diff --git a/docs/man-openmpi/man3/MPIX_Query_rocm_support.3.rst b/docs/man-openmpi/man3/MPIX_Query_rocm_support.3.rst index ceb31b44e50..59f6148079a 100644 --- a/docs/man-openmpi/man3/MPIX_Query_rocm_support.3.rst +++ b/docs/man-openmpi/man3/MPIX_Query_rocm_support.3.rst @@ -94,4 +94,4 @@ EXAMPLES } .. seealso:: - :ref:`MPIX_Query_cuda_support` + * :ref:`MPIX_Query_cuda_support` diff --git a/docs/man-openmpi/man3/MPI_Abort.3.rst b/docs/man-openmpi/man3/MPI_Abort.3.rst index c45ffa4f4b7..935d6ade789 100644 --- a/docs/man-openmpi/man3/MPI_Abort.3.rst +++ b/docs/man-openmpi/man3/MPI_Abort.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -67,9 +67,9 @@ abort (errorcode). The long-term goal of the Open MPI implementation is to terminate all processes in all tasks that contain a process in *comm, and the error code is not returned to the invoking environment. At the moment, this -isn't fully implemented and :ref:`MPI_Abort` will terminate the entire job.* +isn't fully implemented and* :ref:`MPI_Abort` *will terminate the entire job.* -Note: All associated processes are sent a SIGTERM. +Note: All associated processes are sent a ``SIGTERM``. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Accumulate.3.rst b/docs/man-openmpi/man3/MPI_Accumulate.3.rst index 3b9da2c2b1c..06e3f328961 100644 --- a/docs/man-openmpi/man3/MPI_Accumulate.3.rst +++ b/docs/man-openmpi/man3/MPI_Accumulate.3.rst @@ -99,7 +99,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- * ``MPI_Raccumulate``: RMA request -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -145,11 +145,11 @@ The MPI standard prescribes portable Fortran syntax for the *TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND TARGET_DISP -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -172,4 +172,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Put` :ref:`MPI_Get_accumulate` :ref:`MPI_Reduce` + * :ref:`MPI_Put` + * :ref:`MPI_Get_accumulate` + * :ref:`MPI_Reduce` 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 129f340b96b..2cf968cdbb5 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_class.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_class.3.rst @@ -6,9 +6,7 @@ MPI_Add_error_class .. include_body -:: - - MPI_Add_error_class - Creates a new error class and returns its value +:ref:`MPI_Add_error_class` - Creates a new error class and returns its value SYNTAX @@ -50,7 +48,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``errorclass``: New error class (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -83,4 +81,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Add_error_code` :ref:`MPI_Add_error_string` :ref:`MPI_Error_class` :ref:`MPI_Error_string` + * :ref:`MPI_Add_error_code` + * :ref:`MPI_Add_error_string` + * :ref:`MPI_Error_class` + * :ref:`MPI_Error_string` 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 c4fe8f076fe..146b10ce3a8 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errorcode``: Error code returned by an MPI routine or an MPI error class (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -78,4 +78,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Add_error_class` :ref:`MPI_Error_class` + * :ref:`MPI_Add_error_class` + * :ref:`MPI_Error_class` 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 abb61d3ac75..9cda1ac884f 100644 --- a/docs/man-openmpi/man3/MPI_Add_error_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Add_error_string.3.rst @@ -6,9 +6,7 @@ MPI_Add_error_string .. include_body -:: - - MPI_Add_error_string - Associates a string with an error code or class +:ref:`MPI_Add_error_string` - Associates a string with an error code or class SYNTAX @@ -56,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -75,4 +73,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Add_error_class` :ref:`MPI_Add_error_code` :ref:`MPI_Error_class` :ref:`MPI_Error_string` + * :ref:`MPI_Add_error_class` + * :ref:`MPI_Add_error_code` + * :ref:`MPI_Error_class` + * :ref:`MPI_Error_string` diff --git a/docs/man-openmpi/man3/MPI_Address.3.rst b/docs/man-openmpi/man3/MPI_Address.3.rst index e64c4b2c4ee..60261ac9d20 100644 --- a/docs/man-openmpi/man3/MPI_Address.3.rst +++ b/docs/man-openmpi/man3/MPI_Address.3.rst @@ -42,7 +42,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``address``: Address of location (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -55,17 +55,16 @@ function. Returns the (byte) address of location. Example: Using :ref:`MPI_Address` for an array. -:: +.. code-block:: fortran REAL A(100,100) -| -| INTEGER I1, I2, DIFF -| CALL MPI_ADDRESS(A(1,1), I1, IERROR) -| CALL MPI_ADDRESS(A(10,10), I2, IERROR) -| DIFF = I2 - I1 -| ! The value of DIFF is 909*sizeofreal; the values of I1 and I2 are -| ! implementation dependent. + INTEGER I1, I2, DIFF + CALL MPI_ADDRESS(A(1,1), I1, IERROR) + CALL MPI_ADDRESS(A(10,10), I2, IERROR) + DIFF = I2 - I1 + ! The value of DIFF is 909*sizeof(real) + !the values of I1 and I2 are implementation dependent. NOTES @@ -73,7 +72,7 @@ NOTES This routine is provided for both Fortran and C programmers and may be useful when writing portable code. In the current release, the address -returned by this routine will be the same as that produced by the C & +returned by this routine will be the same as that produced by the C ``&`` operator. C users may be tempted to avoid using :ref:`MPI_Address` and rely on the @@ -92,4 +91,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Get_address` + * :ref:`MPI_Get_address` diff --git a/docs/man-openmpi/man3/MPI_Aint_add.3.rst b/docs/man-openmpi/man3/MPI_Aint_add.3.rst index 8ff646eff1f..1dad0df0258 100644 --- a/docs/man-openmpi/man3/MPI_Aint_add.3.rst +++ b/docs/man-openmpi/man3/MPI_Aint_add.3.rst @@ -73,11 +73,11 @@ in the same object referenced by *base*, as described in MPI-3.1 section correct MPI_Aint representation of the output address, as if the process that originally produced *base* had called: -:: +.. code-block:: c - MPI_Get_address ((char *) base + disp, &result); + MPI_Get_address ((char *) base + disp, &result); -**MPI_Aint_diff** produces a new MPI_Aint value that is equivalent to +:ref:`MPI_Aint_diff` produces a new MPI_Aint value that is equivalent to the difference between *addr1* and *addr2* arguments, where *addr1* and *addr2* represent addresses returned by calls to :ref:`MPI_Get_address`. The resulting address is valid only at the @@ -86,9 +86,9 @@ must correspond to locations in the same object in the same process, as described in MPI-3.1 section 4.1.12. The difference is calculated in a manner that results in the signed difference from *addr1* to *addr2*, as if the process that originally produced the addresses had -called (char \*) *addr1* - (char \*) *addr2* on the addresses +called ``(char *) addr1`` - ``(char *) addr2`` on the addresses initially passed to :ref:`MPI_Get_address`. .. seealso:: - :ref:`MPI_Get_address` + * :ref:`MPI_Get_address` diff --git a/docs/man-openmpi/man3/MPI_Allgather.3.rst b/docs/man-openmpi/man3/MPI_Allgather.3.rst index 1b655dd626d..44fc8a2c67e 100644 --- a/docs/man-openmpi/man3/MPI_Allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Allgather.3.rst @@ -112,7 +112,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -126,24 +126,26 @@ The type signature associated with sendcount, sendtype at a process must be equal to the type signature associated with recvcount, recvtype at any other process. -The outcome of a call to MPI_Allgather(...) is as if all processes +The outcome of a call to :ref:`MPI_Allgather` is as if all processes executed n calls to -:: +.. code-block:: c + + MPI_Gather(sendbuf, sendcount, sendtype, recvbuf, recvcount, + recvtype, root, comm); - MPI_Gather(sendbuf,sendcount,sendtype,recvbuf,recvcount, - recvtype,root,comm), + // for root = 0 , ..., n-1. -for root = 0 , ..., n-1. The rules for correct usage of :ref:`MPI_Allgather` +The rules for correct usage of :ref:`MPI_Allgather` are easily found from the corresponding rules for :ref:`MPI_Gather`. **Example:** The all-gather version of Example 1 in :ref:`MPI_Gather`. Using :ref:`MPI_Allgather`, we will gather 100 ints from every process in the group to every process. -:: +.. code-block:: c - MPI_Comm comm; + MPI_Comm comm; int gsize,sendarray[100]; int *rbuf; ... @@ -167,12 +169,12 @@ receive its own contribution to the receive buffer. Specifically, the outcome of a call to :ref:`MPI_Allgather` that used the in-place option is identical to the case in which all processes executed *n* calls to -:: +.. code-block:: c - MPI_ALLGATHER ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf, - recvcount, recvtype, root, comm ) + MPI_Allgather( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf, + recvcount, recvtype, root, comm ) - for root =0, ... , n-1. + // for root =0, ... , n-1. Note that MPI_IN_PLACE is a special kind of value; it has the same restrictions on its use as MPI_BOTTOM. @@ -202,4 +204,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Allgatherv` :ref:`MPI_Gather` + * :ref:`MPI_Allgatherv` + * :ref:`MPI_Gather` diff --git a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst index 81908fbc614..efc5ee540b5 100644 --- a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst @@ -117,7 +117,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -134,12 +134,14 @@ recvtype at any other process. The outcome is as if all processes executed calls to -:: +.. code-block:: c + + MPI_Allgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcount, + displs,recvtype,root,comm); - MPI_Allgatherv(sendbuf,sendcount,sendtype,recvbuf,recvcount, - displs,recvtype,root,comm) + // for root = 0 , ..., n-1. -for root = 0 , ..., n-1. The rules for correct usage of :ref:`MPI_Allgatherv` +The rules for correct usage of :ref:`MPI_Allgatherv` are easily found from the corresponding rules for :ref:`MPI_Gatherv`. @@ -152,15 +154,15 @@ buffer). Use the variable MPI_IN_PLACE as the value of *sendbuf*. In this case, *sendcount* and *sendtype* are ignored. The input data of each process is assumed to be in the area where that process would receive its own contribution to the receive buffer. Specifically, the -outcome of a call to :ref:`MPI_Allgather` that used the in-place option is +outcome of a call to :ref:`MPI_Allgatherv` that used the in-place option is identical to the case in which all processes executed *n* calls to -:: +.. code-block:: c - MPI_ALLGATHERV ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf, - recvcounts, displs, recvtype, root, comm ) + MPI_Allgatherv ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf, + recvcounts, displs, recvtype, root, comm ); - for root =0, ... , n-1. + // for root =0, ... , n-1. Note that MPI_IN_PLACE is a special kind of value; it has the same restrictions on its use as MPI_BOTTOM. @@ -189,4 +191,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Gatherv` :ref:`MPI_Allgather` + * :ref:`MPI_Gatherv` + * :ref:`MPI_Allgather` diff --git a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst index ca46e42b5ad..29e0d96e9db 100644 --- a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst +++ b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``baseptr``: Pointer to beginning of memory segment allocated. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -69,9 +69,9 @@ this memory is returned in the variable *baseptr*. C NOTES ------- -The parameter *baseptr* is of type *void \** to allow passing any +The parameter *baseptr* is of type ``void *`` to allow passing any pointer object for this parameter. The provided argument should be a -pointer to a pointer of arbitrary type (e.g., *void \*\**). +pointer to a pointer of arbitrary type (e.g., ``void **``). FORTRAN NOTES @@ -85,10 +85,11 @@ compilers. From FORTRAN 77, you can use the following non-standard declarations for the SIZE and BASEPTR arguments: -:: +.. code-block:: fortran INCLUDE "mpif.h" INTEGER*MPI_ADDRESS_KIND SIZE, BASEPTR + From either FORTRAN 77 or Fortran 90, you can use "Cray pointers" for the BASEPTR argument. Cray pointers are described further in the Fortran @@ -115,4 +116,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Free_mem` + * :ref:`MPI_Free_mem` diff --git a/docs/man-openmpi/man3/MPI_Allreduce.3.rst b/docs/man-openmpi/man3/MPI_Allreduce.3.rst index 868b6de8aa7..c8fb263f1d5 100644 --- a/docs/man-openmpi/man3/MPI_Allreduce.3.rst +++ b/docs/man-openmpi/man3/MPI_Allreduce.3.rst @@ -105,7 +105,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -117,7 +117,7 @@ of all the group members. array that are distributed across a group of processes and returns the answer at all nodes (compare with Example 2, with :ref:`MPI_Reduce`, below). -:: +.. code-block:: fortran SUBROUTINE PAR_BLAS2(m, n, a, b, c, comm) REAL a(m), b(m,n) ! local slice of array @@ -143,7 +143,7 @@ answer at all nodes (compare with Example 2, with :ref:`MPI_Reduce`, below). array that are distributed across a group of processes and returns the answer at node zero. -:: +.. code-block:: fortran SUBROUTINE PAR_BLAS2(m, n, a, b, c, comm) REAL a(m), b(m,n) ! local slice of array diff --git a/docs/man-openmpi/man3/MPI_Alltoall.3.rst b/docs/man-openmpi/man3/MPI_Alltoall.3.rst index d07d20d06e4..6de7376154d 100644 --- a/docs/man-openmpi/man3/MPI_Alltoall.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoall.3.rst @@ -117,7 +117,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -158,7 +158,7 @@ symmetric, full-duplex behavior. The first group defines the root process. The root process uses MPI_ROOT as the value of *root*. All other processes in the first group use -MPI_PROC_NULL as the value of *root*. All processes in the second group +``MPI_PROC_NULL`` as the value of *root*. All processes in the second group use the rank of the root process in the first group as the value of *root*. @@ -196,4 +196,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alltoallv` :ref:`MPI_Alltoallw` + * :ref:`MPI_Alltoallv` + * :ref:`MPI_Alltoallw` diff --git a/docs/man-openmpi/man3/MPI_Alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Alltoallv.3.rst index 9684f6d1ad2..0f70254204e 100644 --- a/docs/man-openmpi/man3/MPI_Alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoallv.3.rst @@ -131,7 +131,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status. +* ``ierror``: Fortran only: Error status. DESCRIPTION ----------- @@ -145,7 +145,7 @@ process performs 2n (n being the number of processes in communicator *comm*) independent point-to-point communications (including communication with itself). -:: +.. code-block:: c MPI_Comm_size(comm, &n); for (i = 0, i < n; i++) @@ -177,7 +177,7 @@ symmetric, full-duplex behavior. The first group defines the root process. The root process uses MPI_ROOT as the value of *root*. All other processes in the first group use -MPI_PROC_NULL as the value of *root*. All processes in the second group +``MPI_PROC_NULL`` as the value of *root*. All processes in the second group use the rank of the root process in the first group as the value of *root*. @@ -216,4 +216,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alltoall` :ref:`MPI_Alltoallw` + * :ref:`MPI_Alltoall` + * :ref:`MPI_Alltoallw` diff --git a/docs/man-openmpi/man3/MPI_Alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Alltoallw.3.rst index ea44f8d5a2a..67783b46b2c 100644 --- a/docs/man-openmpi/man3/MPI_Alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Alltoallw.3.rst @@ -134,7 +134,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status. +* ``ierror``: Fortran only: Error status. DESCRIPTION ----------- @@ -148,7 +148,7 @@ where each process performs 2n (n being the number of processes in communicator *comm) independent point-to-point communications* (including communication with itself). -:: +.. code-block:: c MPI_Comm_size(comm, &n); for (i = 0, i < n; i++) @@ -181,7 +181,7 @@ symmetric, full-duplex behavior. The first group defines the root process. The root process uses MPI_ROOT as the value of *root*. All other processes in the first group use -MPI_PROC_NULL as the value of *root*. All processes in the second group +``MPI_PROC_NULL`` as the value of *root*. All processes in the second group use the rank of the root process in the first group as the value of *root*. @@ -220,4 +220,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alltoall` :ref:`MPI_Alltoallv` + * :ref:`MPI_Alltoall` + * :ref:`MPI_Alltoallv` diff --git a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst index 6feb661e2d2..c8dbfe9f231 100644 --- a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst @@ -41,7 +41,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -78,4 +78,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_delete_attr` + * :ref:`MPI_Comm_delete_attr` diff --git a/docs/man-openmpi/man3/MPI_Attr_get.3.rst b/docs/man-openmpi/man3/MPI_Attr_get.3.rst index 4df959328ba..a2f255e3b68 100644 --- a/docs/man-openmpi/man3/MPI_Attr_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_get.3.rst @@ -45,7 +45,7 @@ OUTPUT PARAMETERS ----------------- * ``attribute_val``: Attribute value, unless flag = false. * ``flag``: True if an attribute value was extracted; false if no attribute is associated with the key. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -67,4 +67,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_get_attr` + * :ref:`MPI_Comm_get_attr` diff --git a/docs/man-openmpi/man3/MPI_Attr_put.3.rst b/docs/man-openmpi/man3/MPI_Attr_put.3.rst index 97a768e8d12..31c8553dea5 100644 --- a/docs/man-openmpi/man3/MPI_Attr_put.3.rst +++ b/docs/man-openmpi/man3/MPI_Attr_put.3.rst @@ -42,13 +42,13 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- Note that use of this routine is *deprecated as of MPI-2, and* was -*deleted in MPI-3. Please use :ref:`MPI_Comm_set_attr`. This* function does not +deleted in MPI-3. Please use :ref:`MPI_Comm_set_attr`. This function does not have a mpi_f08 binding. :ref:`MPI_Attr_put` stores the stipulated attribute value attribute_val for @@ -68,7 +68,7 @@ Values of the permanent attributes MPI_TAG_UB, MPI_HOST, MPI_IO, and MPI_WTIME_IS_GLOBAL may not be changed. The type of the attribute value depends on whether C or Fortran is being -used. In C, an attribute value is a pointer (void \*); in Fortran, it is +used. In C, an attribute value is a pointer (``void *``); in Fortran, it is a single integer (not a pointer, since Fortran has no pointers and there are systems for which a pointer does not fit in an integer, e.g., any 32-bit address system that uses 64 bits for Fortran DOUBLE PRECISION). @@ -83,4 +83,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_set_attr` + * :ref:`MPI_Comm_set_attr` diff --git a/docs/man-openmpi/man3/MPI_Barrier.3.rst b/docs/man-openmpi/man3/MPI_Barrier.3.rst index cbf119e6fc7..dcfb87ca77a 100644 --- a/docs/man-openmpi/man3/MPI_Barrier.3.rst +++ b/docs/man-openmpi/man3/MPI_Barrier.3.rst @@ -14,18 +14,18 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include int MPI_Barrier(MPI_Comm) int MPI_Ibarrier(MPI_Comm comm, MPI_Request *request) - int MPI_barrier_init(MPI_Comm comm, MPI_Info info, MPI_Request *request) + int MPI_Barrier_init(MPI_Comm comm, MPI_Info info, MPI_Request *request) Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -39,7 +39,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 MPI_Barrier(comm, ierror) @@ -58,14 +58,14 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : Communicator (handle). -- info : Info (handle, persistent only). +* ``comm`` : Communicator (handle). +* ``info`` : Info (handle, persistent only). OUTPUT PARAMETERS ----------------- -- request : Request (handle, non-blocking only). -- IERROR : Fortran only: Error status (integer). +* ``request`` : Request (handle, non-blocking only). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -86,4 +86,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Bcast` +.. seealso:: + * :ref:`MPI_Bcast` diff --git a/docs/man-openmpi/man3/MPI_Bcast.3.rst b/docs/man-openmpi/man3/MPI_Bcast.3.rst index b7f69869696..babc57ed038 100644 --- a/docs/man-openmpi/man3/MPI_Bcast.3.rst +++ b/docs/man-openmpi/man3/MPI_Bcast.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -27,7 +27,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -42,7 +42,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 MPI_Bcast(buffer, count, datatype, root, comm, ierror) @@ -63,17 +63,17 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETERS ----------------------- -- ``buffer``: Starting address of buffer (choice). -- ``count``: Number of entries in buffer (integer). -- ``datatype``: Data type of buffer (handle). -- ``root``: Rank of broadcast root (integer). -- ``comm``: Communicator (handle). +* ``buffer``: Starting address of buffer (choice). +* ``count``: Number of entries in buffer (integer). +* ``datatype``: Data type of buffer (handle). +* ``root``: Rank of broadcast root (integer). +* ``comm``: Communicator (handle). OUTPUT PARAMETERS ----------------- -- ``request``: Request (handle, non-blocking only). -- ``IERROR``: Fortran only: Error status (integer). +* ``request``: Request (handle, non-blocking only). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -95,7 +95,7 @@ are still allowed. **Example:** Broadcast 100 ints from process 0 to every process in the group. -.. code:: C +.. code-block:: C MPI_Comm comm; int array[100]; @@ -114,7 +114,7 @@ When the communicator is an inter-communicator, the root process in the first group broadcasts data to all the processes in the second group. The first group defines the root process. That process uses MPI_ROOT as the value of its ``root`` argument. The remaining processes use -MPI_PROC_NULL as the value of their ``root`` argument. All processes +``MPI_PROC_NULL`` as the value of their ``root`` argument. All processes in the second group use the rank of that root process in the first group as the value of their ``root`` argument. The receive buffer arguments of the processes in the second group must be consistent with the send diff --git a/docs/man-openmpi/man3/MPI_Bsend.3.rst b/docs/man-openmpi/man3/MPI_Bsend.3.rst index 5de4e4897b5..1cb3bc1272f 100644 --- a/docs/man-openmpi/man3/MPI_Bsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Bsend.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 MPI_Bsend(buf, count, datatype, dest, tag, comm, ierror) @@ -48,17 +48,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``buf`` : Initial address of send buffer (choice). -- ``count`` : Number of entries in send buffer (nonnegative integer). -- ``datatype`` : Datatype of each send buffer element (handle). -- ``dest`` : Rank of destination (integer). -- ``tag`` : Message tag (integer). -- ``comm`` : Communicator (handle). +* ``buf`` : Initial address of send buffer (choice). +* ``count`` : Number of entries in send buffer (nonnegative integer). +* ``datatype`` : Datatype of each send buffer element (handle). +* ``dest`` : Rank of destination (integer). +* ``tag`` : Message tag (integer). +* ``comm`` : Communicator (handle). OUTPUT PARAMETERS ----------------- -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -78,7 +78,7 @@ you are certain that the message has been received (not just that it should have been received). For example, this code does not allocate enough buffer space: -.. code:: c +.. code-block:: c MPI_Buffer_attach( b, n*sizeof(double) + MPI_BSEND_OVERHEAD ); for (i=0; i @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -36,7 +36,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -51,18 +51,18 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- buf : Initial address of send buffer (choice). -- count : Number of elements sent (integer). -- datatype : Type of each element (handle). -- dest : Rank of destination (integer). -- tag : Message tag (integer). -- comm : Communicator (handle). +* ``buf`` : Initial address of send buffer (choice). +* ``count`` : Number of elements sent (integer). +* ``datatype`` : Type of each element (handle). +* ``dest`` : Rank of destination (integer). +* ``tag`` : Message tag (integer). +* ``comm`` : Communicator (handle). OUTPUT PARAMETERS ----------------- -- request : Communication request (handle). -- IERROR : Fortran only: Error status (integer). +* ``request`` : Communication request (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst index 400b9bf7f42..deb7aced560 100644 --- a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst +++ b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -46,13 +46,13 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- buf : Initial buffer address (choice). -- size : Buffer size, in bytes (integer). +* ``buf`` : Initial buffer address (choice). +* ``size`` : Buffer size, in bytes (integer). OUTPUT PARAMETER ---------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -69,15 +69,20 @@ that you intend to have, plus MPI_BSEND_OVERHEAD bytes for each Bsend that you do. For the purposes of calculating size, you should use :ref:`MPI_Pack_size`. In other words, in the code -c MPI_Buffer_attach( buf, size ); MPI_Bsend( ..., count=20, -datatype=type1, ... ); //... MPI_Bsend( ..., count=40, datatype=type2, -... ); +.. code-block:: c + + MPI_Buffer_attach( buf, size ) + MPI_Bsend( ..., count=20, datatype=type1, ... ); + MPI_Bsend( ..., count=40, datatype=type2, ... ); the value of size in the :ref:`MPI_Buffer_attach` call should be greater than the value computed by -c MPI_Pack_size( 20, type1, comm, &s1 ); MPI_Pack_size( 40, type2, comm, -&s2 ); size = s1 + s2 + 2 \* MPI_BSEND_OVERHEAD; +.. code-block:: c + + MPI_Pack_size( 20, type1, comm, &s1 ); + MPI_Pack_size( 40, type2, comm, &s2 ); + size = s1 + s2 + 2 * MPI_BSEND_OVERHEAD; MPI_BSEND_OVERHEAD gives the maximum amount of buffer space that may be used by the Bsend routines. This value is in mpi.h for C and mpif.h for @@ -88,4 +93,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Buffer_detach` +.. seealso:: + * :ref:`MPI_Buffer_detach` diff --git a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst index 0d25a40fa4e..49afe2438c7 100644 --- a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst +++ b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -48,9 +48,9 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- -- buf : Initial buffer address (choice). -- size : Buffer size, in bytes (integer). -- IERROR : Fortran only: Error status (integer). +* ``buf`` : Initial buffer address (choice). +* ``size`` : Buffer size, in bytes (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -61,23 +61,38 @@ until all messages currently in the buffer have been transmitted. Upon return of this function, the user may reuse or deallocate the space taken by the buffer. -Example: Calls to attach and detach buffers. c #define BUFFSIZE 10000 +Example: Calls to attach and detach buffers. -int size char *buff; MPI_Buffer_attach( malloc(BUFFSIZE), BUFFSIZE); /* -a buffer of 10000 bytes can now be used by :ref:`MPI_Bsend` */ -MPI_Buffer_detach( &buff, &size); /* Buffer size reduced to zero */ -MPI_Buffer_attach( buff, size); /* Buffer of 10000 bytes available again -\*/ +.. code-block:: c + + #define BUFFSIZE 10000 + + int size char *buff; + MPI_Buffer_attach( malloc(BUFFSIZE), BUFFSIZE); + + // a buffer of 10000 bytes can now be used by MPI_Bsend + + MPI_Buffer_detach( &buff, &size); // Buffer size reduced to zero + MPI_Buffer_attach( buff, size); // Buffer of 10000 bytes available again NOTES ----- The reason that :ref:`MPI_Buffer_detach` returns the address and size of the buffer being detached is to allow nested libraries to replace and -restore the buffer. For example, consider c int size, mysize, idummy; -void \*ptr, \*myptr, *dummy; MPI_Buffer_detach( &ptr, &size ); -MPI_Buffer_attach( myptr, mysize ); /* ... library code ... \*/ -MPI_Buffer_detach( &dummy, &idummy ); MPI_Buffer_attach( ptr, size ); +restore the buffer. For example, consider + +.. code-block:: c + + int size, mysize, idummy; + void *ptr, *myptr, *dummy; + MPI_Buffer_detach( &ptr, &size ); + MPI_Buffer_attach( myptr, mysize ); + + /* ... library code ... */ + + MPI_Buffer_detach( &dummy, &idummy ); + MPI_Buffer_attach( ptr, size ); This is much like the action of the UNIX signal routine and has the same strengths (it's simple) and weak‐nesses (it only works for nested @@ -102,4 +117,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Buffer_attach` +.. seealso:: + * :ref:`MPI_Buffer_attach` diff --git a/docs/man-openmpi/man3/MPI_Cancel.3.rst b/docs/man-openmpi/man3/MPI_Cancel.3.rst index c71fd52412d..2c5bcdebf9c 100644 --- a/docs/man-openmpi/man3/MPI_Cancel.3.rst +++ b/docs/man-openmpi/man3/MPI_Cancel.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -44,12 +44,12 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- request : Communication request (handle). +* ``request`` : Communication request (handle). OUTPUT PARAMETER ---------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -112,4 +112,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Probe` +.. seealso:: + * :ref:`MPI_Probe` diff --git a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst index 3a54b40ed3d..28045b8347f 100644 --- a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,18 +48,18 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``comm`` : Communicator with Cartesian structure (handle). -- ``rank`` : Rank of a process within group of comm (integer). -- ``maxdims`` : Length of vector coords in the calling program +* ``comm`` : Communicator with Cartesian structure (handle). +* ``rank`` : Rank of a process within group of comm (integer). +* ``maxdims`` : Length of vector coords in the calling program (integer). Length of vector coords in the calling program (integer). OUTPUT PARAMETERS ----------------- -- ``coords`` : Integer array (of size ndims,which was defined by +* ``coords`` : Integer array (of size ndims,which was defined by :ref:`MPI_Cart_create` call) containing the Cartesian coordinates of specified process (integer). -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Cart_create.3.rst b/docs/man-openmpi/man3/MPI_Cart_create.3.rst index 06498f59612..a25dbd9fb47 100644 --- a/docs/man-openmpi/man3/MPI_Cart_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_create.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -25,7 +25,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -38,7 +38,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -52,20 +52,20 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``comm_old`` : Input communicator (handle). -- ``ndims`` : Number of dimensions of Cartesian grid (integer). -- ``dims`` : Integer array of size ndims specifying the number of +* ``comm_old`` : Input communicator (handle). +* ``ndims`` : Number of dimensions of Cartesian grid (integer). +* ``dims`` : Integer array of size ndims specifying the number of processes in each dimension. -- ``periods`` : Logical array of size ndims specifying whether the grid +* ``periods`` : Logical array of size ndims specifying whether the grid is periodic (true) or not (false) in each dimension. -- ``reorder`` : Ranking may be reordered (true) or not (false) +* ``reorder`` : Ranking may be reordered (true) or not (false) (logical). OUTPUT PARAMETERS ----------------- -- ``comm_cart`` : Communicator with new Cartesian topology (handle). -- ``IERROR`` : Fortran only: Error status (integer). +* ``comm_cart`` : Communicator with new Cartesian topology (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Cart_get.3.rst b/docs/man-openmpi/man3/MPI_Cart_get.3.rst index 320b34fb804..72d66ec4f02 100644 --- a/docs/man-openmpi/man3/MPI_Cart_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_get.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -36,7 +36,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -50,20 +50,20 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Communicator with Cartesian structure (handle). -- maxdims : Length of vectors dims, periods, and coords in the calling +* ``comm`` : Communicator with Cartesian structure (handle). +* ``maxdims`` : Length of vectors dims, periods, and coords in the calling program (integer). OUTPUT PARAMETERS ----------------- -- dims : Number of processes for each Cartesian dimension (array of +* ``dims`` : Number of processes for each Cartesian dimension (array of integers). -- periods : Periodicity (true/false) for each Cartesian dimension +* ``periods`` : Periodicity (true/false) for each Cartesian dimension (array of logicals). -- coords : Coordinates of calling process in Cartesian structure (array +* ``coords`` : Coordinates of calling process in Cartesian structure (array of integers). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,4 +77,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Cartdim_get` +.. seealso:: + * :ref:`MPI_Cartdim_get` diff --git a/docs/man-openmpi/man3/MPI_Cart_map.3.rst b/docs/man-openmpi/man3/MPI_Cart_map.3.rst index e00321ccd75..432175f7d91 100644 --- a/docs/man-openmpi/man3/MPI_Cart_map.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_map.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -49,19 +49,19 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Input communicator (handle). -- ndims : Number of dimensions of Cartesian structure (integer). -- dims : Integer array of size ndims specifying the number of processes +* ``comm`` : Input communicator (handle). +* ``ndims`` : Number of dimensions of Cartesian structure (integer). +* ``dims`` : Integer array of size ndims specifying the number of processes in each coordinate direction. -- periods : Logical array of size ndims specifying the periodicity +* ``periods`` : Logical array of size ndims specifying the periodicity specification in each coordinate direction. OUTPUT PARAMETERS ----------------- -- newrank : Reordered rank of the calling process; MPI_UNDEFINED if +* ``newrank`` : Reordered rank of the calling process; MPI_UNDEFINED if calling process does not belong to grid (integer). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -79,4 +79,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Graph_map` +.. seealso:: + * :ref:`MPI_Graph_map` diff --git a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst index e7e361bdb85..4e7d23eebf4 100644 --- a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -47,16 +47,16 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Communicator with Cartesian structure (handle). -- coords : Integer array (of size ndims, which was defined by +* ``comm`` : Communicator with Cartesian structure (handle). +* ``coords`` : Integer array (of size ndims, which was defined by :ref:`MPI_Cart_create` call) specifying the Cartesian coordinates of a process. OUTPUT PARAMETER ---------------- -- rank : Rank of specified process (integer). -- IERROR : Fortran only: Error status (integer). +* ``rank`` : Rank of specified process (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,4 +74,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Cart_create` +.. seealso:: + * :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Cart_shift.3.rst b/docs/man-openmpi/man3/MPI_Cart_shift.3.rst index 8f355a574cc..df57c581927 100644 --- a/docs/man-openmpi/man3/MPI_Cart_shift.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_shift.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -37,7 +37,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -50,17 +50,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``comm`` : Communicator with Cartesian structure (handle). -- ``direction`` : Coordinate dimension of shift (integer). -- ``disp`` : Displacement ( > 0: upward shift, < 0: downward shift) +* ``comm`` : Communicator with Cartesian structure (handle). +* ``direction`` : Coordinate dimension of shift (integer). +* ``disp`` : Displacement ( > 0: upward shift, < 0: downward shift) (integer). OUTPUT PARAMETERS ----------------- -- ``rank_source`` : Rank of source process (integer). -- ``rank_dest`` : Rank of destination process (integer). -- ``IERROR`` : Fortran only: Error status (integer). +* ``rank_source`` : Rank of source process (integer). +* ``rank_dest`` : Rank of destination process (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -85,7 +85,7 @@ n-dimensional Cartesian mesh. Depending on the periodicity of the Cartesian group in the specified coordinate ``direction``, :ref:`MPI_Cart_shift` provides the identifiers for a circular or an end-off shift. In the case of an end-off shift, the -value MPI_PROC_NULL may be returned in ``rank_source`` or +value ``MPI_PROC_NULL`` may be returned in ``rank_source`` or ``rank_dest``, indicating that the source or the destination for the shift is out of range. @@ -95,7 +95,7 @@ of REALs is stored one element per process, in variable A. One wishes to skew this array, by shifting column i (vertically, i.e., along the column) by i steps. -.. code:: fortran +.. code-block:: fortran ! find process rank CALL MPI_COMM_RANK(comm, rank, ierr) diff --git a/docs/man-openmpi/man3/MPI_Cart_sub.3.rst b/docs/man-openmpi/man3/MPI_Cart_sub.3.rst index 5aa2b62c7d7..2f01057bfdb 100644 --- a/docs/man-openmpi/man3/MPI_Cart_sub.3.rst +++ b/docs/man-openmpi/man3/MPI_Cart_sub.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -48,17 +48,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Communicator with Cartesian structure (handle). -- remain_dims : The ith entry of remain_dims specifies whether the ith +* ``comm`` : Communicator with Cartesian structure (handle). +* ``remain_dims`` : The ith entry of remain_dims specifies whether the ith dimension is kept in the subgrid (true) or is dropped (false) (logical vector). OUTPUT PARAMETERS ----------------- -- comm_new : Communicator containing the subgrid that includes the +* ``comm_new`` : Communicator containing the subgrid that includes the calling process (handle). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -70,12 +70,12 @@ build for each subgroup a communicator with the associated subgrid Cartesian topology. (This function is closely related to :ref:`MPI_Comm_split`.) -Example: Assume that MPI_Cart_create( ..., comm) has defined a (2 x 3 x +Example: Assume that ``MPI_Cart_create( ..., comm)`` has defined a (2 x 3 x 4) grid. Let remain_dims = (true, false, true). Then a call to -:: +.. code-block:: c - MPI_Cart_sub(comm, remain_dims, comm_new) + MPI_Cart_sub(comm, remain_dims, comm_new); will create three communicators, each with eight processes in a 2 x 4 Cartesian topology. If remain_dims = (false, false, true) then the call @@ -88,4 +88,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Cart_create` +.. seealso:: + * :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst b/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst index 90b9ce948ed..e519466a3f7 100644 --- a/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Cartdim_get.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,13 +46,13 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : Communicator with Cartesian structure (handle). +* ``comm`` : Communicator with Cartesian structure (handle). OUTPUT PARAMETERS ----------------- -- ndims : Number of dimensions of the Cartesian structure (integer). -- IERROR : Fortran only: Error status (integer). +* ``ndims`` : Number of dimensions of the Cartesian structure (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,4 +65,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Cart_get` +.. seealso:: + * :ref:`MPI_Cart_get` diff --git a/docs/man-openmpi/man3/MPI_Close_port.3.rst b/docs/man-openmpi/man3/MPI_Close_port.3.rst index 3598e980955..12c7bb9caf7 100644 --- a/docs/man-openmpi/man3/MPI_Close_port.3.rst +++ b/docs/man-openmpi/man3/MPI_Close_port.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,12 +45,12 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- ``port_name`` : A port (string). +* ``port_name`` : A port (string). OUTPUT PARAMETER ---------------- -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst index 643a44bf018..ec5012e3ff5 100644 --- a/docs/man-openmpi/man3/MPI_Comm_accept.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_accept.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -49,17 +49,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- port_name : Port name (string, used only on *root*). -- info : Options given by root for the accept (handle, used only on +* ``port_name`` : Port name (string, used only on *root*). +* ``info`` : Options given by root for the accept (handle, used only on root). No options currently supported. -- root : Rank in *comm* of root node (integer). -- comm : Intracommunicator over which call is collective (handle). +* ``root`` : Rank in *comm* of root node (integer). +* ``comm`` : Intracommunicator over which call is collective (handle). OUTPUT PARAMETERS ----------------- -- newcomm : Intercommunicator with client as remote group (handle) -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : Intercommunicator with client as remote group (handle) +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -76,4 +76,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_connect` +.. seealso:: + * :ref:`MPI_Comm_connect` 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 82e25c85d61..eb0cb0a11b5 100644 --- a/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_call_errhandler.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -46,13 +46,13 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : communicator with error handler (handle). -- errorcode : error code (integer). +* ``comm`` : communicator with error handler (handle). +* ``errorcode`` : error code (integer). OUTPUT PARAMETERS ----------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,4 +74,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_create_errhandler` +.. seealso:: + * :ref:`MPI_Comm_create_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Comm_compare.3.rst b/docs/man-openmpi/man3/MPI_Comm_compare.3.rst index 4f7e2ee5a6c..f0c151bfefe 100644 --- a/docs/man-openmpi/man3/MPI_Comm_compare.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_compare.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,14 +45,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``comm1`` : Comm1 (handle). -- ``comm2`` : Comm2 (handle). +* ``comm1`` : Comm1 (handle). +* ``comm2`` : Comm2 (handle). OUTPUT PARAMETERS ----------------- -- ``result`` : Result of comparison (integer). -- ``IERROR`` : Fortran only: Error status (integer). +* ``result`` : Result of comparison (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst index cb53fa26d8e..916636ba1d3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_connect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_connect.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -50,17 +50,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- port_name : Port name (string, used only on *root*). -- info : Options given by root for the connect (handle, used only on +* ``port_name`` : Port name (string, used only on *root*). +* ``info`` : Options given by root for the connect (handle, used only on root). No options currently supported. -- root : Rank in *comm* of root node (integer). -- comm : Intracommunicator over which call is collective (handle). +* ``root`` : Rank in *comm* of root node (integer). +* ``comm`` : Intracommunicator over which call is collective (handle). OUTPUT PARAMETERS ----------------- -- newcomm : Intercommunicator with client as remote group (handle) -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : Intercommunicator with client as remote group (handle) +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,4 +84,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_accept` +.. seealso:: + * :ref:`MPI_Comm_accept` diff --git a/docs/man-openmpi/man3/MPI_Comm_create.3.rst b/docs/man-openmpi/man3/MPI_Comm_create.3.rst index 7e66ec21b79..7e30b25277b 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -46,14 +46,14 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : Communicator (handle). -- group : Group, which is a subset of the group of comm (handle). +* ``comm`` : Communicator (handle). +* ``group`` : Group, which is a subset of the group of comm (handle). OUTPUT PARAMETERS ----------------- -- newcomm : New communicator (handle). -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : New communicator (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,4 +84,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_split` +.. seealso:: + * :ref:`MPI_Comm_split` 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 b84bfe4a648..2993cc7e5a3 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_errhandler.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -36,7 +36,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,22 +48,21 @@ Fortran 2008 Syntax Deprecated Type Name Note ------------------------- -MPI-2.2 deprecated the MPI_Comm_errhandler_fn and -``MPI::Comm::Errhandler_fn`` types in favor of -MPI_Comm_errhandler_function and ``MPI::Comm::Errhandler_function``, -respectively. Open MPI supports both names (indeed, the \_fn names are -typedefs to the \_function names). +MPI-2.2 deprecated the ``MPI_Comm_errhandler_fn`` type in favor of +``MPI_Comm_errhandler_function``. +Open MPI supports both names (indeed, the ``_fn`` names are +typedefs to the ``_function`` names). INPUT PARAMETER --------------- -- ``function`` : User-defined error handling procedure (function). +* ``function`` : User-defined error handling procedure (function). OUTPUT PARAMETERS ----------------- -- ``errhandler`` : MPI error handler (handle). -- ``IERROR`` : Fortran only: Error status (integer). +* ``errhandler`` : MPI error handler (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,9 +71,9 @@ DESCRIPTION attached to communicators. This ``function`` is identical to :ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the user routine should be a ``function`` of type -MPI_Comm_errhandler_function, which is defined as +``MPI_Comm_errhandler_function``, which is defined as -.. code:: c +.. code-block:: c typedef void MPI_Comm_errhandler_function(MPI_Comm *, int *, ...); @@ -83,7 +82,7 @@ code to be returned by the MPI routine that raised the error. This typedef replaces ``MPI_Handler_function``, the use of which is deprecated. In Fortran, the user routine should be of this form: -.. code:: fortran +.. code-block:: fortran SUBROUTINE COMM_ERRHANDLER_FUNCTION(COMM, ERROR_CODE, ...) INTEGER COMM, ERROR_CODE 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 c639f05ef44..e060ec06107 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 @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -50,17 +50,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- group : Group (handler) -- stringtag : Unique identifier for this operation (string) -- info : info object (handler) -- errhandler : error handler to be attached to the new +* ``group`` : Group (handler) +* ``stringtag`` : Unique identifier for this operation (string) +* ``info`` : info object (handler) +* ``errhandler`` : error handler to be attached to the new intra-communicator (handle) OUTPUT PARAMETERS ----------------- -- newcomm : New communicator (handle). -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : New communicator (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -96,4 +96,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_create_group` +.. seealso:: + * :ref:`MPI_Comm_create_group` 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 76fcc30ade2..4830f73409d 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_group.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: C +.. code-block:: C #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -47,15 +47,15 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Communicator (handle). -- group : Group, which is a subset of the group of comm (handle). -- tag : Tag (integer). +* ``comm`` : Communicator (handle). +* ``group`` : Group, which is a subset of the group of comm (handle). +* ``tag`` : Tag (integer). OUTPUT PARAMETERS ----------------- -- newcomm : New communicator (handle). -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : New communicator (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -95,4 +95,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_create` +.. seealso:: + * :ref:`MPI_Comm_create` 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 c37274f1c80..febb4abc0d1 100644 --- a/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_create_keyval.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -25,7 +25,7 @@ C Syntax Fortran Syntax (See Fortran 77 Notes) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -40,7 +40,7 @@ Fortran Syntax (See Fortran 77 Notes) Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -55,17 +55,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``comm_copy_attr_fn`` : Copy callback function for ``comm_keyval`` +* ``comm_copy_attr_fn`` : Copy callback function for ``comm_keyval`` (function). -- ``comm_delete_attr_fn`` : Delete callback function for +* ``comm_delete_attr_fn`` : Delete callback function for ``comm_keyval`` (function). -- ``extra_state`` : Extra state for callback functions. +* ``extra_state`` : Extra state for callback functions. OUTPUT PARAMETER ---------------- -- ``comm_keyval`` : Key value for future access (integer). -- ``IERROR`` : Fortran only: Error status (integer). +* ``comm_keyval`` : Key value for future access (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,7 +84,7 @@ 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:: c +.. code-block:: c typedef int MPI_Comm_copy_attr_function(MPI_Comm oldcomm, int comm_keyval, void *extra_state, void *attribute_val_in, @@ -96,7 +96,7 @@ The two C callback functions are: which are the same as the MPI-1.1 calls but with a new name. The old names are deprecated. The two Fortran callback functions are: -.. code:: fortran +.. code-block:: fortran SUBROUTINE COMM_COPY_ATTR_FN(OLDCOMM, COMM_KEYVAL, EXTRA_STATE, ATTRIBUTE_VAL_IN, ATTRIBUTE_VAL_OUT, FLAG, IERROR) @@ -119,11 +119,11 @@ The MPI standard prescribes portable Fortran syntax for the ``EXTRA_STATE`` argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -.. code:: fortran +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND EXTRA_STATE -where ``MPI_ADDRESS_KIND`` is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. ERRORS 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 8888918f09e..5756fed2742 100644 --- a/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_delete_attr.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,17 +46,17 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ^^^^^^^^^^^^^^^^^^^^^^ -- ``comm`` : Communicator from which the attribute is deleted (handle). +* ``comm`` : Communicator from which the attribute is deleted (handle). INPUT PARAMETER --------------- -- ``comm_keyval`` : Key value (integer). +* ``comm_keyval`` : Key value (integer). OUTPUT PARAMETER ---------------- -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst b/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst index b9b5ba53236..b7f3f793073 100644 --- a/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_disconnect.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,12 +45,12 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ^^^^^^^^^^^^^^^^^^^^^^ -- comm : Communicator (handle). +* ``comm`` : Communicator (handle). OUTPUT PARAMETER ---------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -80,4 +80,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Comm_connect` +.. seealso:: + * :ref:`MPI_Comm_connect` diff --git a/docs/man-openmpi/man3/MPI_Comm_dup.3.rst b/docs/man-openmpi/man3/MPI_Comm_dup.3.rst index 46cd3f45c17..cf8de2c6663 100644 --- a/docs/man-openmpi/man3/MPI_Comm_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_dup.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,13 +46,13 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : Communicator (handle). +* ``comm`` : Communicator (handle). OUTPUT PARAMETERS ----------------- -- newcomm : Copy of comm (handle). -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : Copy of comm (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 ee71ec7084c..816dd0e2a9b 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 @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,14 +47,14 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : Communicator (handle). -- info : Info argument (handle). +* ``comm`` : Communicator (handle). +* ``info`` : Info argument (handle). OUTPUT PARAMETERS ----------------- -- newcomm : Copy of comm (handle). -- IERROR : Fortran only: Error status (integer). +* ``newcomm`` : Copy of comm (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Comm_free.3.rst b/docs/man-openmpi/man3/MPI_Comm_free.3.rst index 3bc108b61d2..acafe33d8e2 100644 --- a/docs/man-openmpi/man3/MPI_Comm_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_free.3.rst @@ -51,7 +51,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -81,4 +81,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_delete_attr` + * :ref:`MPI_Comm_delete_attr` 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 19ebc35bd4c..9d7ebaab0cb 100644 --- a/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_free_keyval.3.rst @@ -52,7 +52,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 cbdff53e1a3..2aeb2804613 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_attr.3.rst @@ -60,7 +60,7 @@ OUTPUT PARAMETER ---------------- * ``attribute_val``: Attribute value, unless f\ *lag* = false. * ``flag``: False if no attribute is associated with the key (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -83,11 +83,11 @@ The MPI standard prescribes portable Fortran syntax for the *ATTRIBUTE_VAL* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 2e91c5e29f7..4b32bea0a87 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_errhandler.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: New error handler for communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 56dd096bb1d..7770f43a88f 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_info.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``info_used``: New info object returned with all active hints on this communicator. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,4 +72,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_get_info` :ref:`MPI_Info_free` + * :ref:`MPI_Comm_get_info` + * :ref:`MPI_Info_free` 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 267bd77c7c2..e8632b595b9 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_name.3.rst @@ -57,7 +57,7 @@ OUTPUT PARAMETER ---------------- * ``comm_name``: Name previously stored on the communicator, or an empty string if no such name exists (string). * ``resultlen``: Length of returned name (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 c7e9bd80b1c..8bd230f5c21 100644 --- a/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_get_parent.3.rst @@ -49,7 +49,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``parent``: The parent communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,4 +84,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_spawn` :ref:`MPI_Comm_spawn_multiple` + * :ref:`MPI_Comm_spawn` + * :ref:`MPI_Comm_spawn_multiple` diff --git a/docs/man-openmpi/man3/MPI_Comm_group.3.rst b/docs/man-openmpi/man3/MPI_Comm_group.3.rst index 249d2f4a7ab..479084dfd46 100644 --- a/docs/man-openmpi/man3/MPI_Comm_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_group.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``group``: Group in communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Comm_idup.3.rst b/docs/man-openmpi/man3/MPI_Comm_idup.3.rst index 37b861c9cea..7218ca6058d 100644 --- a/docs/man-openmpi/man3/MPI_Comm_idup.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_idup.3.rst @@ -56,7 +56,7 @@ OUTPUT PARAMETERS ----------------- * ``newcomm``: Copy of comm (handle). * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -104,4 +104,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_dup` :ref:`MPI_Comm_dup_with_info` + * :ref:`MPI_Comm_dup` + * :ref:`MPI_Comm_dup_with_info` 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 284841a5483..0bc58bb336b 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 @@ -57,7 +57,7 @@ OUTPUT PARAMETERS ----------------- * ``newcomm``: Copy of comm (handle). * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -107,4 +107,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_dup` :ref:`MPI_Comm_idup` :ref:`MPI_Comm_dup_with_info` + * :ref:`MPI_Comm_dup` + * :ref:`MPI_Comm_idup` + * :ref:`MPI_Comm_dup_with_info` diff --git a/docs/man-openmpi/man3/MPI_Comm_join.3.rst b/docs/man-openmpi/man3/MPI_Comm_join.3.rst index d825d4cf830..eba7aaf2612 100644 --- a/docs/man-openmpi/man3/MPI_Comm_join.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_join.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``intercomm``: Intercommunicator between processes (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -94,4 +94,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - socket(3SOCKET) :ref:`MPI_Comm_create` :ref:`MPI_Comm_group` + * socket(3SOCKET) + * :ref:`MPI_Comm_create` + * :ref:`MPI_Comm_group` diff --git a/docs/man-openmpi/man3/MPI_Comm_rank.3.rst b/docs/man-openmpi/man3/MPI_Comm_rank.3.rst index 9d95337652f..10e496bd7b1 100644 --- a/docs/man-openmpi/man3/MPI_Comm_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_rank.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``rank``: Rank of the calling process in group of comm (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,4 +77,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_group` :ref:`MPI_Comm_size` :ref:`MPI_Comm_compare` + * :ref:`MPI_Comm_group` + * :ref:`MPI_Comm_size` + * :ref:`MPI_Comm_compare` 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 a3ca39fb49e..1bf52c2083a 100644 --- a/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_remote_group.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``group``: Remote group of communicator. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,5 +72,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_test_inter` :ref:`MPI_Comm_remote_size` :ref:`MPI_Intercomm_create` - :ref:`MPI_Intercomm_merge` + * :ref:`MPI_Comm_test_inter` + * :ref:`MPI_Comm_remote_size` + * :ref:`MPI_Intercomm_create` + * :ref:`MPI_Intercomm_merge` 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 8049a8b21f7..5a770098ca9 100644 --- a/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_remote_size.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``size``: Number of processes in the remote group of comm (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,5 +72,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_test_inter` :ref:`MPI_Comm_remote_group` :ref:`MPI_Intercomm_create` - :ref:`MPI_Intercomm_merge` + * :ref:`MPI_Comm_test_inter` + * :ref:`MPI_Comm_remote_group` + * :ref:`MPI_Intercomm_create` + * :ref:`MPI_Intercomm_merge` 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 3616a8a5f67..296b49dc169 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_attr.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -85,11 +85,11 @@ The MPI standard prescribes portable Fortran syntax for the *ATTRIBUTE_VAL* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -100,7 +100,7 @@ Values of the permanent attributes MPI_TAG_UB, MPI_HOST, MPI_IO, and MPI_WTIME_IS_GLOBAL may not be changed. The type of the attribute value depends on whether C or Fortran is being -used. In C, an attribute value is a pointer (void \*); in Fortran, it is +used. In C, an attribute value is a pointer (``void *``); in Fortran, it is a single, address-size integer system for which a pointer does not fit in an integer. 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 00cdad6209f..323d570e413 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_errhandler.3.rst @@ -55,7 +55,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: New error handler for communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 1ecb377b024..23d9069e0ac 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_info.3.rst @@ -53,13 +53,13 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- -:ref:`MPI_COMM_SET_INFO` sets new values for the hints of the communicator -associated with *comm*. :ref:`MPI_COMM_SET_INFO` is a collective routine. The +:ref:`MPI_Comm_set_info` sets new values for the hints of the communicator +associated with *comm*. :ref:`MPI_Comm_set_info` is a collective routine. The info object may be different on each process, but any info entries that an implementation requires to be the same on all processes must appear with the same value in each process's *info* object. @@ -67,12 +67,12 @@ with the same value in each process's *info* object. The following info key assertions may be accepted by Open MPI: *mpi_assert_no_any_tag* (boolean): If set to true, then the -implementation may assume that the process will not use the MPI_ANY_TAG +implementation may assume that the process will not use the ``MPI_ANY_TAG`` wildcard on the given communicator. *mpi_assert_no_any_source* (boolean): If set to true, then the implementation may assume that the process will not use the -MPI_ANY_SOURCE wildcard on the given communicator. +``MPI_ANY_SOURCE`` wildcard on the given communicator. *mpi_assert_exact_length* (boolean): If set to true, then the implementation may assume that the lengths of messages received by the @@ -95,4 +95,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_get_info` :ref:`MPI_Info_create` :ref:`MPI_Info_set` :ref:`MPI_Info_free` + * :ref:`MPI_Comm_get_info` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_set` + * :ref:`MPI_Info_free` 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 0c20e345ccf..d5bc5f61294 100644 --- a/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_set_name.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -100,4 +100,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_get_name` + * :ref:`MPI_Comm_get_name` diff --git a/docs/man-openmpi/man3/MPI_Comm_size.3.rst b/docs/man-openmpi/man3/MPI_Comm_size.3.rst index 1cb56390b5a..4d9d7f40e76 100644 --- a/docs/man-openmpi/man3/MPI_Comm_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_size.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``size``: Number of processes in the group of comm (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -87,4 +87,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_group` :ref:`MPI_Comm_rank` :ref:`MPI_Comm_compare` + * :ref:`MPI_Comm_group` + * :ref:`MPI_Comm_rank` + * :ref:`MPI_Comm_compare` diff --git a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst index 27b7fa7f470..af5468d0473 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn.3.rst @@ -70,7 +70,7 @@ OUTPUT PARAMETER ---------------- * ``intercomm``: Intercommunicator between original group and the newly spawned group (handle). * ``array_of_errcodes``: One code per process (array of integers). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -146,7 +146,7 @@ The *info* Argument The *info* argument is an opaque handle of type MPI_Info in C and INTEGER in Fortran. It is a container for a number of user-specified (*key,value*) pairs. *key* and *value* are strings (null-terminated -char\* in C, character*(*) in Fortran). Routines to create and +``char *`` in C, ``character*(*)`` in Fortran). Routines to create and manipulate the *info* argument are described in Section 4.10 of the MPI-2 standard. @@ -275,4 +275,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_spawn_multiple` :ref:`MPI_Comm_get_parent` mpirun(1) + * :ref:`MPI_Comm_spawn_multiple` + * :ref:`MPI_Comm_get_parent` + * :ref:`mpirun(1) ` 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 88a079a4896..192b870a027 100644 --- a/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_spawn_multiple.3.rst @@ -75,7 +75,7 @@ OUTPUT PARAMETERS ----------------- * ``intercomm``: Intercommunicator between original group and the newly spawned group (handle). * ``array_of_errcodes``: One code per process (array of integers). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -91,12 +91,12 @@ For the Fortran version of *array_of_argv*, the element *array_of_argv*\ (i,j) is the jth argument to command number i. In any language, an application may use the constant MPI_ARGVS_NULL -(which is likely to be (char \***)0 in C) to specify that no arguments +(which is likely to be ``(char **)0`` in C) to specify that no arguments should be passed to any commands. The effect of setting individual elements of *array_of_argv* to MPI_ARGV_NULL is not defined. To specify arguments for some commands but not others, the commands without arguments should have a corresponding *argv* whose first element is null -((char \*)0 in C and empty string in Fortran). +``((char *)0`` in C and empty string in Fortran). All of the spawned processes have the same MPI_COMM_WORLD. Their ranks in MPI_COMM_WORLD correspond directly to the order in which the commands @@ -273,4 +273,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_spawn` :ref:`MPI_Comm_get_parent` mpirun(1) + * :ref:`MPI_Comm_spawn` + * :ref:`MPI_Comm_get_parent` + * :ref:`mpirun(1) ` diff --git a/docs/man-openmpi/man3/MPI_Comm_split.3.rst b/docs/man-openmpi/man3/MPI_Comm_split.3.rst index ef5a423a039..40fcbdd05d6 100644 --- a/docs/man-openmpi/man3/MPI_Comm_split.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_split.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newcomm``: New communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -125,4 +125,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_create` :ref:`MPI_Intercomm_create` :ref:`MPI_Comm_dup` :ref:`MPI_Comm_free` + * :ref:`MPI_Comm_create` + * :ref:`MPI_Intercomm_create` + * :ref:`MPI_Comm_dup` + * :ref:`MPI_Comm_free` 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 9a2039ec8d3..96bd7208633 100644 --- a/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_split_type.3.rst @@ -60,7 +60,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newcomm``: New communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -147,5 +147,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_create` :ref:`MPI_Intercomm_create` :ref:`MPI_Comm_dup` :ref:`MPI_Comm_free` - :ref:`MPI_Comm_split` + * :ref:`MPI_Comm_create` + * :ref:`MPI_Intercomm_create` + * :ref:`MPI_Comm_dup` + * :ref:`MPI_Comm_free` + * :ref:`MPI_Comm_split` 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 5b9ec97319c..ba519c3db73 100644 --- a/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst +++ b/docs/man-openmpi/man3/MPI_Comm_test_inter.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``flag (Logical.)``: -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -70,11 +70,14 @@ within a single group), the functions listed below return the expected values, group size, group, and rank. When dealing with an inter-communicator, however, they return the following values: -:: +:ref:`MPI_Comm_size` + Returns the size of the local group. - MPI_Comm_size Returns the size of the local group. - MPI_Comm_group Returns the local group. - MPI_Comm_rank Returns the rank in the local group. +:ref:`MPI_Comm_group` + Returns the local group. + +:ref:`MPI_Comm_rank` + Returns the rank in the local group. To return the remote group and remote group size of an inter-communicator, use the :ref:`MPI_Comm_remote_group` and @@ -100,5 +103,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_remote_group` :ref:`MPI_Comm_remote_size` :ref:`MPI_Intercomm_create` - :ref:`MPI_Intercomm_merge` + * :ref:`MPI_Comm_remote_group` + * :ref:`MPI_Comm_remote_size` + * :ref:`MPI_Intercomm_create` + * :ref:`MPI_Intercomm_merge` 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 2b4858cf7ff..81b4454e122 100644 --- a/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst +++ b/docs/man-openmpi/man3/MPI_Compare_and_swap.3.rst @@ -68,7 +68,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -94,11 +94,11 @@ The MPI standard prescribes portable Fortran syntax for the *TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND TARGET_DISP -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_Dims_create.3.rst b/docs/man-openmpi/man3/MPI_Dims_create.3.rst index 9bf36bc2dbf..7174e4551d0 100644 --- a/docs/man-openmpi/man3/MPI_Dims_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Dims_create.3.rst @@ -58,7 +58,7 @@ IN/OUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 56c0ff2ca79..6905d42097d 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_create.3.rst @@ -71,7 +71,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``comm_dist_graph``: Communicator with distributed graph topology added (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -139,5 +139,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Dist_graph_create_adjacent` :ref:`MPI_Dist_graph_neighbors` - :ref:`MPI_Dist_graph_neighbors_count` + * :ref:`MPI_Dist_graph_create_adjacent` + * :ref:`MPI_Dist_graph_neighbors` + * :ref:`MPI_Dist_graph_neighbors_count` 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 559c368539c..62b8ae8b856 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 @@ -73,7 +73,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``comm_dist_graph``: Communicator with distributed graph topology added (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -128,5 +128,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Dist_graph_create` :ref:`MPI_Dist_graph_neighbors` - :ref:`MPI_Dist_graph_neighbors_count` + * :ref:`MPI_Dist_graph_create` + * :ref:`MPI_Dist_graph_neighbors` + * :ref:`MPI_Dist_graph_neighbors_count` 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 52764eaaf63..9c4822bf89a 100644 --- a/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst +++ b/docs/man-openmpi/man3/MPI_Dist_graph_neighbors.3.rst @@ -65,7 +65,7 @@ OUTPUT PARAMETERS * ``sourceweights``: Weights of the edges into the calling process (array of non-negative integers). * ``destinations``: Processes for which the calling process is a source (array of non-negative integers). * ``destweights``: Weights of the edges out of the calling process (array of non-negative integers). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -88,4 +88,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Dist_graph_neighbors_count` + * :ref:`MPI_Dist_graph_neighbors_count` 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 ab08500f726..9814b38af43 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 @@ -60,7 +60,7 @@ OUTPUT PARAMETERS * ``indegree``: Number of edges into this process (non-negative integer). * ``outdegree``: Number of edges out of this process (non-negative integer). * ``weighted``: False if MPI_UNWEIGHTED was supplied during creation, true otherwise (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,4 +77,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Dist_graph_neighbors` + * :ref:`MPI_Dist_graph_neighbors` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst index f2441b5edf0..460d19af0c2 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_create.3.rst @@ -38,12 +38,14 @@ Fortran Syntax INPUT PARAMETER --------------- + * ``function``: User-defined error handling procedure. OUTPUT PARAMETERS ----------------- + * ``errhandler``: MPI error handler (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -57,7 +59,7 @@ Returns in errhandler a handle to the registered error handler. In the C language, the user routine should be a C function of type MPI_Handler_function, which is defined as -:: +.. code-block:: c typedef void (MPI_Handler_function)(MPI_Comm *, int *, ...); @@ -76,7 +78,7 @@ NOTE The MPI-1 Standard states that an implementation may make the output value (errhandler) simply the address of the function. However, the -action of MPI_Errhandler\_ free makes this impossible, since it is +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 addition, the actual error handler must remain until all communicators that use it are freed. @@ -88,5 +90,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` - :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_Comm_create_errhandler` + * :ref:`MPI_Comm_get_errhandler` + * :ref:`MPI_Comm_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst index 82b291d4cf2..7ca75555adb 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_free.3.rst @@ -51,7 +51,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -68,5 +68,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` - :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_Comm_create_errhandler` + * :ref:`MPI_Comm_get_errhandler` + * :ref:`MPI_Comm_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst index c359a8bb96c..0a256722695 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_get.3.rst @@ -41,7 +41,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: MPI error handler currently associated with communicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -64,5 +64,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` - :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_Comm_create_errhandler` + * :ref:`MPI_Comm_get_errhandler` + * :ref:`MPI_Comm_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst index 9215c7cebc4..2d8e454f564 100644 --- a/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst +++ b/docs/man-openmpi/man3/MPI_Errhandler_set.3.rst @@ -41,7 +41,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -60,5 +60,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_create_errhandler` :ref:`MPI_Comm_get_errhandler` - :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_Comm_create_errhandler` + * :ref:`MPI_Comm_get_errhandler` + * :ref:`MPI_Comm_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Error_class.3.rst b/docs/man-openmpi/man3/MPI_Error_class.3.rst index 219c1adcf69..05c6d1aa320 100644 --- a/docs/man-openmpi/man3/MPI_Error_class.3.rst +++ b/docs/man-openmpi/man3/MPI_Error_class.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errorclass``: Error class associated with errorcode. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -68,4 +68,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Error_string` + * :ref:`MPI_Error_string` diff --git a/docs/man-openmpi/man3/MPI_Error_string.3.rst b/docs/man-openmpi/man3/MPI_Error_string.3.rst index 767d64ce386..69822afd205 100644 --- a/docs/man-openmpi/man3/MPI_Error_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Error_string.3.rst @@ -56,7 +56,7 @@ OUTPUT PARAMETERS ----------------- * ``string``: Text that corresponds to the errorcode. * ``resultlen``: Length of string. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -75,4 +75,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Error_class` + * :ref:`MPI_Error_class` diff --git a/docs/man-openmpi/man3/MPI_Exscan.3.rst b/docs/man-openmpi/man3/MPI_Exscan.3.rst index 440201b2f65..4fad9c889fa 100644 --- a/docs/man-openmpi/man3/MPI_Exscan.3.rst +++ b/docs/man-openmpi/man3/MPI_Exscan.3.rst @@ -102,7 +102,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -172,4 +172,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Op_create` :ref:`MPI_Reduce` :ref:`MPI_Scan` + * :ref:`MPI_Op_create` + * :ref:`MPI_Reduce` + * :ref:`MPI_Scan` 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 e7ce36539d7..8c74c4d59ac 100644 --- a/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst +++ b/docs/man-openmpi/man3/MPI_Fetch_and_op.3.rst @@ -70,7 +70,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -104,11 +104,11 @@ The MPI standard prescribes portable Fortran syntax for the *TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND TARGET_DISP -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -127,4 +127,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Get_accumulate` :ref:`MPI_Reduce` + * :ref:`MPI_Get_accumulate` + * :ref:`MPI_Reduce` 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 418d52287a5..f013b33149f 100644 --- a/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_call_errhandler.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,4 +74,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_File_create_errhandler` :ref:`MPI_File_set_errhandler` + * :ref:`MPI_File_create_errhandler` + * :ref:`MPI_File_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_File_close.3.rst b/docs/man-openmpi/man3/MPI_File_close.3.rst index a22542641f6..a0b4da30e6c 100644 --- a/docs/man-openmpi/man3/MPI_File_close.3.rst +++ b/docs/man-openmpi/man3/MPI_File_close.3.rst @@ -52,7 +52,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 8829f1c12b3..76abdb15e41 100644 --- a/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_create_errhandler.3.rst @@ -52,36 +52,35 @@ Fortran 2008 Syntax DEPRECATED TYPE NAME NOTE ------------------------- -MPI-2.2 deprecated the MPI_File_errhandler_fn and -MPI::file::Errhandler_fn types in favor of MPI_File_errhandler_function -and MPI::File::Errhandler_function, respectively. Open MPI supports both -names (indeed, the \_fn names are typedefs to the \_function names). +MPI-2.2 deprecated the ``MPI_File_errhandler_fn`` type in favor of +``MPI_File_errhandler_function``. Open MPI supports both +names (indeed, the ``_fn`` names are typedefs to the ``_function`` names). INPUT PARAMETER --------------- + * ``function``: User-defined error handling procedure (function). OUTPUT PARAMETERS ----------------- + * ``errhandler``: MPI error handler (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- -Registers the user routine *function* for use as an MPI error handler. -Returns in errhandler a handle to the registered error handler. +:ref:`MPI_Comm_create_errhandler` creates an error handler that can be +attached to file operations. In C, the +user routine should be a ``function`` of type +``MPI_File_errhandler_function``, which is defined as -In the C language, the user routine *function* should be a C function of -type MPI_File_errhandler_function, which is defined as - -:: +.. code-block:: c - typedef void (MPI_File_errhandler_function)(MPI_File *, int *, - ...); + typedef void (MPI_File_errhandler_function)(MPI_File *, int *, ...); -The first argument to *function* is the file in use. The second is the +The first argument is the file in use. The second is the error code to be returned by the MPI routine that raised the error. In the Fortran language, the user routine should be of the form: diff --git a/docs/man-openmpi/man3/MPI_File_delete.3.rst b/docs/man-openmpi/man3/MPI_File_delete.3.rst index 612ac45cd34..465d1944397 100644 --- a/docs/man-openmpi/man3/MPI_File_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_File_delete.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 18cd358456f..32dd0ae5672 100644 --- a/docs/man-openmpi/man3/MPI_File_get_amode.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_amode.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``amode``: File access mode used to open the file (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 8b0900d3eae..1d1107a4bf8 100644 --- a/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_atomicity.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- * ``flag``: true if atomic mode is enabled, false if nonatomic mode is enabled (boolean). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 498b95e073d..1aaa67899bd 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 @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``disp``: Absolute byte position of offset (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,13 +77,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* and *DISP* arguments only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET - or - INTEGER*MPI_OFFSET_KIND DISP + INTEGER*MPI_OFFSET_KIND OFFSET, DISP -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 a6c368d89e5..fc5c2082f36 100644 --- a/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_errhandler.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: MPI error handler currently associated with file (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 03a7452a1a4..de575c7ced5 100644 --- a/docs/man-openmpi/man3/MPI_File_get_group.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_group.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``group``: Group that opened the file (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 8df1a61cef5..b77a8b1501d 100644 --- a/docs/man-openmpi/man3/MPI_File_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_info.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``info_used``: New info object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 8ac6ef5712b..a5858701e80 100644 --- a/docs/man-openmpi/man3/MPI_File_get_position.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_position.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``offset``: Offset of the individual file pointer (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -73,11 +73,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 35c129456e9..27a9ebea755 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 @@ -56,7 +56,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``offset``: Offset of the shared file pointer (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -73,11 +73,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 6d05b0dba2a..29a0c5aae43 100644 --- a/docs/man-openmpi/man3/MPI_File_get_size.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_size.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,11 +74,11 @@ The MPI standard prescribes portable Fortran syntax for the *SIZE* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_OFFSET_KIND SIZE -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -88,4 +88,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_File_preallocate` + * :ref:`MPI_File_preallocate` 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 380bfe8db04..91dc4e2b1d8 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 @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``extent``: Data type extent (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -78,11 +78,11 @@ The MPI standard prescribes portable Fortran syntax for the *EXTENT* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND EXTENT -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 a2ea7619a7e..0f524df6898 100644 --- a/docs/man-openmpi/man3/MPI_File_get_view.3.rst +++ b/docs/man-openmpi/man3/MPI_File_get_view.3.rst @@ -64,7 +64,7 @@ OUTPUT PARAMETERS * ``etype``: Elementary data type (handle). * ``filetype``: File type (handle). See Restrictions, below. * ``datarep``: Data representation (string). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,11 +84,11 @@ The MPI standard prescribes portable Fortran syntax for the *DISP* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax. -:: +.. code-block:: fortran INTEGER*MPI_OFFSET_KIND DISP -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_File_iread.3.rst b/docs/man-openmpi/man3/MPI_File_iread.3.rst index 712f1a0252f..5eaec9729f1 100644 --- a/docs/man-openmpi/man3/MPI_File_iread.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread.3.rst @@ -66,7 +66,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 9c54e871244..5d11419154b 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_all.3.rst @@ -66,7 +66,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 39fffd7d2e7..1d920bb75fa 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_at.3.rst @@ -67,7 +67,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of the buffer (choice). * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -91,11 +91,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 71202a85b9a..69cfa8e1505 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 @@ -67,7 +67,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of the buffer (choice). * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -92,11 +92,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 6656eb0807c..8ee47828b4d 100644 --- a/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iread_shared.3.rst @@ -66,7 +66,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst index 9a674775443..eeef229e219 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst @@ -66,7 +66,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 6efa599c077..d84031c44e0 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst @@ -66,7 +66,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 bffb5f1c6bb..739234a4a17 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst @@ -69,7 +69,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -96,11 +96,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 80656428641..b8e9c8f2c98 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 @@ -69,7 +69,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -97,11 +97,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 c0677a4706d..67788a39bb6 100644 --- a/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_iwrite_shared.3.rst @@ -66,7 +66,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``request``: Request object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_File_open.3.rst b/docs/man-openmpi/man3/MPI_File_open.3.rst index c62d4ae5296..d49d08334f4 100644 --- a/docs/man-openmpi/man3/MPI_File_open.3.rst +++ b/docs/man-openmpi/man3/MPI_File_open.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``fh``: New file handle (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst index 2c3b33e118b..77ee49120c4 100644 --- a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst +++ b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -89,11 +89,11 @@ The MPI standard prescribes portable Fortran syntax for the *SIZE* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND SIZE + INTEGER*MPI_OFFSET_KIND SIZE -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_File_read.3.rst b/docs/man-openmpi/man3/MPI_File_read.3.rst index b32e0ed2859..976fd2dca40 100644 --- a/docs/man-openmpi/man3/MPI_File_read.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read.3.rst @@ -64,7 +64,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (integer). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 a442cc73635..758563227dd 100644 --- a/docs/man-openmpi/man3/MPI_File_read_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_all.3.rst @@ -64,7 +64,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 9e2cf5c9809..5e27c0a2e0a 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 @@ -65,7 +65,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 93442273b80..cf3e71c6afc 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 @@ -60,7 +60,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 802c7c504a0..e3a034f0314 100644 --- a/docs/man-openmpi/man3/MPI_File_read_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_at.3.rst @@ -68,7 +68,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -91,11 +91,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 9503d65b208..a95074138bc 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 @@ -68,7 +68,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -92,11 +92,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 709f27e46a4..7d113cd9416 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 @@ -66,7 +66,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -87,11 +87,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -99,7 +99,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_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst index 886afc0f20c..197ddccb181 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 @@ -59,7 +59,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 666abeed834..21c0fe76526 100644 --- a/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_ordered.3.rst @@ -64,7 +64,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (Status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 44e50b11945..d9e2a5d6f90 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 @@ -65,7 +65,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 9f491027caf..5143eab7573 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 @@ -60,7 +60,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 22f4359cc42..a6e20d1c16d 100644 --- a/docs/man-openmpi/man3/MPI_File_read_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_read_shared.3.rst @@ -67,7 +67,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_File_seek.3.rst b/docs/man-openmpi/man3/MPI_File_seek.3.rst index 44ef986ab18..0b134ffeb92 100644 --- a/docs/man-openmpi/man3/MPI_File_seek.3.rst +++ b/docs/man-openmpi/man3/MPI_File_seek.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -66,11 +66,9 @@ DESCRIPTION :ref:`MPI_File_seek` updates the individual file pointer according to *whence,* which could have the following possible values: - o MPI_SEEK_SET - The pointer is set to *offset.* - - o MPI_SEEK_CUR - The pointer is set to the current pointer position plus *offset.* - - o MPI_SEEK_END - The pointer is set to the end of the file plus *offset.* +* ``MPI_SEEK_SET`` - The pointer is set to *offset.* +* ``MPI_SEEK_CUR`` - The pointer is set to the current pointer position plus *offset.* +* ``MPI_SEEK_END`` - The pointer is set to the end of the file plus *offset.* The *offset* can be negative, which allows seeking backwards. It is erroneous to seek to a negative position in the file. The end of the @@ -86,11 +84,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 f31c76a7759..c58b089c683 100644 --- a/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_seek_shared.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -67,11 +67,9 @@ DESCRIPTION :ref:`MPI_File_seek_shared` updates the shared file pointer according to *whence,* which could have the following possible values: - o MPI_SEEK_SET - The pointer is set to *offset.* - - o MPI_SEEK_CUR - The pointer is set to the current pointer position plus *offset.* - - o MPI_SEEK_END - The pointer is set to the end of the file plus *offset.* +* ``MPI_SEEK_SET`` - The pointer is set to *offset.* +* ``MPI_SEEK_CUR`` - The pointer is set to the current pointer position plus *offset.* +* ``MPI_SEEK_END`` - The pointer is set to the end of the file plus *offset.* :ref:`MPI_File_seek_shared` is collective; all the processes in the communicator group associated with the file handle *fh* must call @@ -93,11 +91,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 4e4b67b791d..8b82617e672 100644 --- a/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_atomicity.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 da6f4a4b906..1591dd81c7a 100644 --- a/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_errhandler.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 ed71d0d9c79..e24f4484cc1 100644 --- a/docs/man-openmpi/man3/MPI_File_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_info.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 fa6658d0ee3..ae8326d2549 100644 --- a/docs/man-openmpi/man3/MPI_File_set_size.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_size.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -88,11 +88,11 @@ The MPI standard prescribes portable Fortran syntax for the *SIZE* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND SIZE + INTEGER*MPI_OFFSET_KIND SIZE -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 89fb92fe79f..03408801247 100644 --- a/docs/man-openmpi/man3/MPI_File_set_view.3.rst +++ b/docs/man-openmpi/man3/MPI_File_set_view.3.rst @@ -70,7 +70,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -169,11 +169,11 @@ The MPI standard prescribes portable Fortran syntax for the *DISP* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND DISP + INTEGER*MPI_OFFSET_KIND DISP -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_File_sync.3.rst b/docs/man-openmpi/man3/MPI_File_sync.3.rst index 5f249550ea8..ae7a8d3d86e 100644 --- a/docs/man-openmpi/man3/MPI_File_sync.3.rst +++ b/docs/man-openmpi/man3/MPI_File_sync.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_File_write.3.rst b/docs/man-openmpi/man3/MPI_File_write.3.rst index bd465228d5a..26808b87be4 100644 --- a/docs/man-openmpi/man3/MPI_File_write.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write.3.rst @@ -68,7 +68,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 ee2545085a0..30f15d31dc1 100644 --- a/docs/man-openmpi/man3/MPI_File_write_all.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_all.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 778fc14872d..1c838cd2931 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 @@ -65,7 +65,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 73dc77a421f..8cbf2b69166 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 @@ -62,7 +62,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 352b31ff30e..83d1635b2ab 100644 --- a/docs/man-openmpi/man3/MPI_File_write_at.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_at.3.rst @@ -67,7 +67,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -92,11 +92,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -106,5 +106,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_File_iwrite_at` :ref:`MPI_File_write_at_all` :ref:`MPI_File_write_at_all_begin` - :ref:`MPI_File_write_at_all_end` + * :ref:`MPI_File_iwrite_at` + * :ref:`MPI_File_write_at_all` + * :ref:`MPI_File_write_at_all_begin` + * :ref:`MPI_File_write_at_all_end` 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 6f1c125d31b..8f80acbc343 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 @@ -67,7 +67,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -92,11 +92,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 cf1a32b450f..aeac0027970 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 @@ -67,7 +67,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -88,11 +88,11 @@ The MPI standard prescribes portable Fortran syntax for the *OFFSET* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_OFFSET_KIND OFFSET + INTEGER*MPI_OFFSET_KIND OFFSET -where MPI_OFFSET_KIND is a constant defined in mpif.h and gives the +where ``MPI_OFFSET_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 5130d485644..398e8144d76 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 @@ -62,7 +62,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 eb94a44ae22..a71debc3ce4 100644 --- a/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_ordered.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -25,7 +25,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -38,7 +38,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -53,16 +53,16 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``fh`` : File handle (handle). -- ``buf`` : Initial address of buffer (choice). -- ``count`` : Number of elements in buffer (integer). -- ``datatype`` : Data type of each buffer element (handle). +* ``fh`` : File handle (handle). +* ``buf`` : Initial address of buffer (choice). +* ``count`` : Number of elements in buffer (integer). +* ``datatype`` : Data type of each buffer element (handle). OUTPUT PARAMETERS ----------------- -- ``status`` : Status object (Status). -- ``IERROR`` : Fortran only: Error status (integer). +* ``status`` : Status object (Status). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 1b178a9885a..077bf9140e5 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 @@ -15,7 +15,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -25,7 +25,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -37,7 +37,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -51,19 +51,19 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ---------------------- -- ``fh`` : File handle (handle). +* ``fh`` : File handle (handle). INPUT PARAMETERS ---------------- -- ``buf`` : Initial address of buffer (choice). -- ``count`` : Number of elements in buffer (integer). -- ``datatype`` : Data type of each buffer element (handle). +* ``buf`` : Initial address of buffer (choice). +* ``count`` : Number of elements in buffer (integer). +* ``datatype`` : Data type of each buffer element (handle). OUTPUT PARAMETER ---------------- -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 694a37eb39b..b2c422ddb3e 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 @@ -15,7 +15,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -25,7 +25,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -37,7 +37,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -50,18 +50,18 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ---------------------- -- ``fh`` : File handle (handle). +* ``fh`` : File handle (handle). INPUT PARAMETER --------------- -- ``buf`` : Initial address of buffer (choice). +* ``buf`` : Initial address of buffer (choice). OUTPUT PARAMETERS ----------------- -- ``status`` : Status object (status). -- ``IERROR`` : Fortran only: Error status (integer). +* ``status`` : Status object (status). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 4bd34c3a9a6..aec00a07725 100644 --- a/docs/man-openmpi/man3/MPI_File_write_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_File_write_shared.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -36,7 +36,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -51,20 +51,20 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ---------------------- -- ``fh`` : File handle (handle). +* ``fh`` : File handle (handle). INPUT PARAMETERS ---------------- -- ``buf`` : Initial address of buffer (choice). -- ``count`` : Number of elements in buffer (integer). -- ``datatype`` : Data type of each buffer element (handle). +* ``buf`` : Initial address of buffer (choice). +* ``count`` : Number of elements in buffer (integer). +* ``datatype`` : Data type of each buffer element (handle). OUTPUT PARAMETERS ----------------- -- ``status`` : Status object (status). -- ``IERROR`` : Fortran only: Error status (integer). +* ``status`` : Status object (status). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Finalize.3.rst b/docs/man-openmpi/man3/MPI_Finalize.3.rst index d4fc8e09d7d..3fef1fe0d46 100644 --- a/docs/man-openmpi/man3/MPI_Finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_Finalize.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -43,7 +43,7 @@ Fortran 2008 Syntax OUTPUT PARAMETER ---------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Finalized.3.rst b/docs/man-openmpi/man3/MPI_Finalized.3.rst index b872ca14cb1..6d34fa9ded6 100644 --- a/docs/man-openmpi/man3/MPI_Finalized.3.rst +++ b/docs/man-openmpi/man3/MPI_Finalized.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,8 +45,8 @@ Fortran 2008 Syntax OUTPUT PARAMETER ---------------- -- flag : True if MPI was finalized, and false otherwise (logical). -- IERROR : Fortran only: Error status (integer). +* ``flag`` : True if MPI was finalized, and false otherwise (logical). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Free_mem.3.rst b/docs/man-openmpi/man3/MPI_Free_mem.3.rst index 181b2050a40..faff69f2fc7 100644 --- a/docs/man-openmpi/man3/MPI_Free_mem.3.rst +++ b/docs/man-openmpi/man3/MPI_Free_mem.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,13 +45,13 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- base : Initial address of memory segment allocated by :ref:`MPI_Alloc_mem` +* ``base`` : Initial address of memory segment allocated by :ref:`MPI_Alloc_mem` (choice). OUTPUT PARAMETER ---------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Gather.3.rst b/docs/man-openmpi/man3/MPI_Gather.3.rst index 403e64f0af4..6a37a659d02 100644 --- a/docs/man-openmpi/man3/MPI_Gather.3.rst +++ b/docs/man-openmpi/man3/MPI_Gather.3.rst @@ -14,7 +14,7 @@ Synopsis C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -33,7 +33,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -59,7 +59,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -96,24 +96,24 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- sendbuf : Starting address of send buffer (choice). -- sendcount : Number of elements in send buffer (integer). -- sendtype : Datatype of send buffer elements (handle). -- recvcount : Number of elements for any single receive (integer, - significant only at root). -- recvtype : Datatype of recvbuffer elements (handle, significant only - at root). -- root : Rank of receiving process (integer). -- comm : Communicator (handle). -- info : Info (handle, persistent only). +* ``sendbuf`` : Starting address of send buffer (choice). +* ``sendcount`` : Number of elements in send buffer (integer). +* ``sendtype`` : Datatype of send buffer elements (handle). +* ``recvcount`` : Number of elements for any single receive (integer, + significant only at root). +* ``recvtype`` : Datatype of recvbuffer elements (handle, significant only + at root). +* ``root`` : Rank of receiving process (integer). +* ``comm`` : Communicator (handle). +* ``info`` : Info (handle, persistent only). OUTPUT PARAMETERS ----------------- -- recvbuf : Address of receive buffer (choice, significant only at +* ``recvbuf`` : Address of receive buffer (choice, significant only at root). -- request : Request (handle, non-blocking only). -- IERROR : Fortran only: Error status (integer). +* ``request`` : Request (handle, non-blocking only). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -123,20 +123,24 @@ buffer to the root process. The root process receives the messages and stores them in rank order. The outcome is as if each of the n processes in the group (including the root process) had executed a call to -c MPI_Send(sendbuf, sendcount, sendtype, root, ...) +:: + + MPI_Send(sendbuf, sendcount, sendtype, root, ...) and the root had executed n calls to -c MPI_Recv(recfbuf + i \* recvcount \* extent(recvtype), recvcount, -recvtype, i, ...) +:: + + MPI_Recv(recfbuf + i * recvcount * extent(recvtype), recvcount, + recvtype, i, ...) where extent(recvtype) is the type extent obtained from a call to -MPI_Type_extent(). +:ref:`MPI_Type_extent`. An alternative description is that the n messages sent by the processes in the group are concatenated in rank order, and the resulting message -is received by the root as if by a call to MPI_RECV(recvbuf, recvcount\* -n, recvtype, ... ). +is received by the root as if by a call to +``MPI_Recv(recvbuf, recvcount * n, recvtype, ... )``. The receive buffer is ignored for all nonroot processes. @@ -159,35 +163,54 @@ receives from each process, not the total number of items it receives. Example 1: Gather 100 ints from every process in group to root. -c MPI_Comm comm; int gsize,sendarray[100]; int root, \*rbuf; //... +.. code-block:: c + + MPI_Comm comm; + int gsize, sendarray[100]; + int root, *rbuf; + ... -MPI_Comm_size( comm, &gsize); rbuf = (int -*)malloc(gsize*\ 100*sizeof(int)); + MPI_Comm_size( comm, &gsize); + rbuf = (int*)malloc(gsize* 100*sizeof(int)); -MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm); + MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm); Example 2: Previous example modified -- only the root allocates memory for the receive buffer. -c MPI_Comm comm; int gsize,sendarray[100]; int root, myrank, \*rbuf; -//... +.. code-block:: c + + MPI_Comm comm; + int gsize, sendarray[100]; + int root, myrank, *rbuf; + ... -MPI_Comm_rank( comm, myrank); if ( myrank == root) { MPI_Comm_size( -comm, &gsize); rbuf = (int *)malloc(gsize*\ 100*sizeof(int)); } -MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm); + MPI_Comm_rank( comm, myrank); + if ( myrank == root) { + MPI_Comm_size( comm, &gsize); + rbuf = (int *)malloc(gsize * 100*sizeof(int)); + } + MPI_Gather( sendarray, 100, MPI_INT, rbuf, 100, MPI_INT, root, comm); Example 3: Do the same as the previous example, but use a derived -datatype. Note that the type cannot be the entire set of gsize \* 100 +datatype. Note that the type cannot be the entire set of ``gsize * 100`` ints since type matching is defined pairwise between the root and each process in the gather. -c MPI_Comm comm; int gsize,sendarray[100]; int root, \*rbuf; -MPI_Datatype rtype; //... +.. code-block:: c + + MPI_Comm comm; + int gsize, sendarray[100]; + int root, *rbuf; + MPI_Datatype rtype; + ... + + MPI_Comm_size( comm, &gsize); + MPI_Type_contiguous( 100, MPI_INT, &rtype); + MPI_Type_commit( &rtype ); + rbuf = (int*)malloc(gsize* 100*sizeof(int)); + MPI_Gather( sendarray, 100, MPI_INT, rbuf, 1, rtype, root, comm); -MPI_Comm_size( comm, &gsize); MPI_Type_contiguous( 100, MPI_INT, &rtype -); MPI_Type_commit( &rtype ); rbuf = (int -*)malloc(gsize*\ 100*sizeof(int)); MPI_Gather( sendarray, 100, MPI_INT, -rbuf, 1, rtype, root, comm); Use Of In-Place Option ---------------------- @@ -209,7 +232,7 @@ When Communicator Is An Inter-Communicator When the communicator is an inter-communicator, the root process in the first group gathers data from all the processes in the second group. The first group defines the root process. That process uses MPI_ROOT as the -value of its root argument. The remaining processes use MPI_PROC_NULL as +value of its root argument. The remaining processes use ``MPI_PROC_NULL`` as the value of their root argument. All processes in the second group use the rank of that root process in the first group as the value of their root argument. The send buffer argument of the processes in the first @@ -221,4 +244,5 @@ ERRORS .. include:: ./ERRORS.rst -.. seealso:: :ref:`MPI_Gatherv` +.. seealso:: + * :ref:`MPI_Gatherv` diff --git a/docs/man-openmpi/man3/MPI_Gatherv.3.rst b/docs/man-openmpi/man3/MPI_Gatherv.3.rst index 0fa4898263b..6817a969439 100644 --- a/docs/man-openmpi/man3/MPI_Gatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Gatherv.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -33,7 +33,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -59,7 +59,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -98,28 +98,28 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- sendbuf : Starting address of send buffer (choice). -- sendcount : Number of elements in send buffer (integer). -- sendtype : Datatype of send buffer elements (handle). -- recvcounts : Integer array (of length group size) containing the +* ``sendbuf`` : Starting address of send buffer (choice). +* ``sendcount`` : Number of elements in send buffer (integer). +* ``sendtype`` : Datatype of send buffer elements (handle). +* ``recvcounts`` : Integer array (of length group size) containing the number of elements that are received from each process (significant only at root). -- displs : Integer array (of length group size). Entry i specifies the +* ``displs`` : Integer array (of length group size). Entry i specifies the displacement relative to recvbuf at which to place the incoming data from process i (significant only at root). -- recvtype : Datatype of recv buffer elements (significant only at +* ``recvtype`` : Datatype of recv buffer elements (significant only at root) (handle). -- root : Rank of receiving process (integer). -- comm : Communicator (handle). -- info : Info (handle, persistent only). +* ``root`` : Rank of receiving process (integer). +* ``comm`` : Communicator (handle). +* ``info`` : Info (handle, persistent only). OUTPUT PARAMETERS ----------------- -- recvbuf : Address of receive buffer (choice, significant only at +* ``recvbuf`` : Address of receive buffer (choice, significant only at root). -- request : Request (handle, non-blocking only). -- IERROR : Fortran only: Error status (integer). +* ``request`` : Request (handle, non-blocking only). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -132,12 +132,16 @@ the root, by providing the new argument, displs. The outcome is as if each process, including the root process, sends a message to the root, -c MPI_Send(sendbuf, sendcount, sendtype, root, ...) +.. code-block:: c + + MPI_Send(sendbuf, sendcount, sendtype, root, ...); and the root executes n receives, -c MPI_Recv(recvbuf + disp[i] \* extent(recvtype), recvcounts[i], -recvtype, i, ...) +.. code-block:: c + + MPI_Recv(recvbuf + disp[i] * extent(recvtype), recvcounts[i], + recvtype, i, ...); Messages are placed in the receive buffer of the root process in rank order, that is, the data sent from process j is placed in the jth @@ -167,43 +171,87 @@ Example 1: Now have each process send 100 ints to root, but place each set (of 100) stride ints apart at receiving end. Use :ref:`MPI_Gatherv` and the displs argument to achieve this effect. Assume stride >= 100. -c MPI_Comm comm; int gsize,sendarray[100]; int root, \*rbuf, stride; int -*displs,i,\ rcounts; // ... MPI_Comm_size(comm, &gsize); rbuf = (int -)malloc(gsize\ stride\ sizeof(int)); displs = (int -)malloc(gsize\ sizeof(int)); rcounts = (int )malloc(gsize\ sizeof(int)); -for (i=0; i @@ -29,7 +29,7 @@ C Syntax Fortran Syntax (See Fortran 77 Notes) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -51,7 +51,7 @@ Fortran Syntax (See Fortran 77 Notes) Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -78,23 +78,23 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- origin_addr : Initial address of origin buffer (choice). -- origin_count : Number of entries in origin buffer (nonnegative +* ``origin_addr`` : Initial address of origin buffer (choice). +* ``origin_count`` : Number of entries in origin buffer (nonnegative integer). -- origin_datatype : Data type of each entry in origin buffer (handle). -- target_rank : Rank of target (nonnegative integer). -- target_disp : Displacement from window start to the beginning of the +* ``origin_datatype`` : Data type of each entry in origin buffer (handle). +* ``target_rank`` : Rank of target (nonnegative integer). +* ``target_disp`` : Displacement from window start to the beginning of the target buffer (nonnegative integer). -- target_count : Number of entries in target buffer (nonnegative +* ``target_count`` : Number of entries in target buffer (nonnegative integer). -- target datatype : datatype of each entry in target buffer (handle) -- win : window object used for communication (handle) +* target datatype : datatype of each entry in target buffer (handle) +* ``win`` : window object used for communication (handle) OUTPUT PARAMETER ---------------- -- request : :ref:`MPI_Rget`: RMA request -- IERROR : Fortran only: Error status (integer). +* ``request`` : :ref:`MPI_Rget`: RMA request +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -122,7 +122,7 @@ syntax fortran INTEGERMPI_ADDRESS_KIND TARGET_DISP -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst b/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst index ec3d6eaf30a..e80f5a08e73 100644 --- a/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_accumulate.3.rst @@ -15,7 +15,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -35,7 +35,7 @@ C Syntax Fortran Syntax (See Fortran 77 Notes) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -59,7 +59,7 @@ Fortran Syntax (See Fortran 77 Notes) Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -92,27 +92,27 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- origin_addr : Initial address of buffer (choice). -- origin_count : Number of entries in buffer (nonnegative integer). -- origin_datatype : Data type of each buffer entry (handle). -- result_addr : Initial address of result buffer (choice). -- result_count : Number of entries in result buffer (nonnegative +* ``origin_addr`` : Initial address of buffer (choice). +* ``origin_count`` : Number of entries in buffer (nonnegative integer). +* ``origin_datatype`` : Data type of each buffer entry (handle). +* ``result_addr`` : Initial address of result buffer (choice). +* ``result_count`` : Number of entries in result buffer (nonnegative integer). -- result_datatype : Data type of each result buffer entry (handle). -- target_rank : Rank of target (nonnegative integer). -- target_disp : Displacement from start of window to beginning of +* ``result_datatype`` : Data type of each result buffer entry (handle). +* ``target_rank`` : Rank of target (nonnegative integer). +* ``target_disp`` : Displacement from start of window to beginning of target buffer (nonnegative integer). -- target_count : Number of entries in target buffer (nonnegative +* ``target_count`` : Number of entries in target buffer (nonnegative integer). -- target_datatype : Data type of each entry in target buffer (handle). -- op : Reduce operation (handle). -- win : Window object (handle). +* ``target_datatype`` : Data type of each entry in target buffer (handle). +* ``op`` : Reduce operation (handle). +* ``win`` : Window object (handle). OUTPUT PARAMETER ---------------- -- :ref:`MPI_Rget_accumulate`: RMA request -- IERROR : Fortran only: Error status (integer). +* :ref:`MPI_Rget_accumulate`: RMA request +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -164,7 +164,7 @@ syntax fortran INTEGERMPI_ADDRESS_KIND TARGET_DISP -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. NOTES diff --git a/docs/man-openmpi/man3/MPI_Get_address.3.rst b/docs/man-openmpi/man3/MPI_Get_address.3.rst index 98f94597cdb..c73b68f99c1 100644 --- a/docs/man-openmpi/man3/MPI_Get_address.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_address.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,13 +47,13 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``location`` : Location in caller memory (choice). +* ``location`` : Location in caller memory (choice). OUTPUT PARAMETERS ----------------- -- ``address`` : Address of location (integer). -- ``IERROR`` : Fortran only: Error status (integer). +* ``address`` : Address of location (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -63,7 +63,7 @@ memory. Example: Using :ref:`MPI_Get_address` for an array. -.. code:: fortran +.. code-block:: fortran EAL A(100,100) INTEGER I1, I2, DIFF diff --git a/docs/man-openmpi/man3/MPI_Get_count.3.rst b/docs/man-openmpi/man3/MPI_Get_count.3.rst index 21624a6e089..d33da12e69b 100644 --- a/docs/man-openmpi/man3/MPI_Get_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_count.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,14 +47,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- status : Return status of receive operation (status). -- datatype : Datatype of each receive buffer element (handle). +* ``status`` : Return status of receive operation (status). +* ``datatype`` : Datatype of each receive buffer element (handle). OUTPUT PARAMETERS ----------------- -- count : Number of received elements (integer). -- IERROR : Fortran only: Error status (integer). +* ``count`` : Number of received elements (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Get_elements.3.rst b/docs/man-openmpi/man3/MPI_Get_elements.3.rst index 6a6bd2c70d3..13aecb7fa45 100644 --- a/docs/man-openmpi/man3/MPI_Get_elements.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_elements.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -27,7 +27,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -43,7 +43,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -62,13 +62,13 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- status : Return status of receive operation (status). -- datatype : Datatype used by receive operation (handle). +* ``status`` : Return status of receive operation (status). +* ``datatype`` : Datatype used by receive operation (handle). OUTPUT PARAMETERS ----------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -87,33 +87,31 @@ the count parameter cannot express the value to be returned (e.g., if the parameter is too small to hold the output value), it is set to MPI_UNDEFINED. -Example: Usage of :ref:`MPI_Get_count` and MPI_Get_element: +Example: Usage of :ref:`MPI_Get_count` and :ref:`MPI_Get_elements`: -fortran //... MPI_TYPE_CONTIGUOUS(2, MPI_REAL, Type2, ierr) -MPI_TYPE_COMMIT(Type2, ierr) // ... MPI_COMM_RANK(comm, rank, ierr) -IF(rank.EQ.0) THEN CALL MPI_SEND(a, 2, MPI_REAL, 1, 0, comm, ierr) CALL -MPI_SEND(a, 3, MPI_REAL, 1, 0, comm, ierr) ELSE CALL MPI_RECV(a, 2, -Type2, 0, 0, comm, stat, ierr) CALL MPI_GET_COUNT(stat, Type2, i, ierr) -! returns i=1 CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=2 -CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr) CALL -MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=MPI_UNDEFINED +.. code-block:: fortran -:: + call MPI_TYPE_CONTIGUOUS(2, MPI_REAL, Type2, ierr) + call MPI_TYPE_COMMIT(Type2, ierr) + call MPI_COMM_RANK(comm, rank, ierr) - CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=3 - -END IF + IF ( rank == 0 ) THEN + CALL MPI_SEND(a, 2, MPI_REAL, 1, 0, comm, ierr) + CALL MPI_SEND(a, 3, MPI_REAL, 1, 0, comm, ierr) + ELSE + CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr) + CALL MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=1 + CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=2 + CALL MPI_RECV(a, 2, Type2, 0, 0, comm, stat, ierr) + CALL MPI_GET_COUNT(stat, Type2, i, ierr) ! returns i=MPI_UNDEFINED + CALL MPI_GET_ELEMENTS(stat, Type2, i, ierr) ! returns i=3 + END IF The function :ref:`MPI_Get_elements` can also be used after a probe to find the number of elements in the probed message. Note that the two functions :ref:`MPI_Get_count` and :ref:`MPI_Get_elements` return the same values when they are used with primitive data types. -ERRORS ------- - -.. include:: ./ERRORS.rst - FORTRAN 77 NOTES ---------------- @@ -121,10 +119,17 @@ The MPI standard prescribes portable Fortran syntax for the COUNT argument of :ref:`MPI_Get_elements_x` only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -Fortran INTEGERMPI_COUNT_KIND COUNT +.. code-block:: fortran -where MPI_COUNT_KIND is a constant defined in mpif.h and gives the + INTEGER*MPI_COUNT_KIND COUNT + +where ``MPI_COUNT_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. +ERRORS +------ + +.. include:: ./ERRORS.rst + .. seealso:: :ref:`MPI_Get_count` 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 b71082b18f0..10d9d9ab9b9 100644 --- a/docs/man-openmpi/man3/MPI_Get_library_version.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_library_version.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,10 +47,10 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- -- version : A string containing the Open MPI version (string). -- resultlen : Length (in characters) of result returned in version +* ``version`` : A string containing the Open MPI version (string). +* ``resultlen`` : Length (in characters) of result returned in version (integer). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 d74a14e8537..baf582ec9a6 100644 --- a/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_processor_name.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,10 +46,10 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- -- ``name`` : A unique specifier for the actual (as opposed to virtual) +* ``name`` : A unique specifier for the actual (as opposed to virtual) node. -- ``resultlen`` : Length (in characters) of result returned in name. -- ``IERROR`` : Fortran only: Error status (integer). +* ``resultlen`` : Length (in characters) of result returned in name. +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Get_version.3.rst b/docs/man-openmpi/man3/MPI_Get_version.3.rst index 2fbf64fde75..6d0cc7a2e82 100644 --- a/docs/man-openmpi/man3/MPI_Get_version.3.rst +++ b/docs/man-openmpi/man3/MPI_Get_version.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,11 +45,11 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- -- ``version`` : The major version number of the corresponding standard +* ``version`` : The major version number of the corresponding standard (integer). -- ``subversion`` : The minor version number of the corresponding +* ``subversion`` : The minor version number of the corresponding standard (integer). -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Graph_create.3.rst b/docs/man-openmpi/man3/MPI_Graph_create.3.rst index e0ab29ae4dd..ae521006711 100644 --- a/docs/man-openmpi/man3/MPI_Graph_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_create.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -38,7 +38,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -53,17 +53,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm_old : Input communicator without topology (handle). -- nnodes : Number of nodes in graph (integer). -- index : Array of integers describing node degrees (see below). -- edges : Array of integers describing graph edges (see below). -- reorder : Ranking may be reordered (true) or not (false) (logical). +* ``comm_old`` : Input communicator without topology (handle). +* ``nnodes`` : Number of nodes in graph (integer). +* ``index`` : Array of integers describing node degrees (see below). +* ``edges`` : Array of integers describing graph edges (see below). +* ``reorder`` : Ranking may be reordered (true) or not (false) (logical). OUTPUT PARAMETERS ----------------- -- comm_graph : Communicator with graph topology added (handle). -- IERROR : Fortran only: Error status (integer). +* ``comm_graph`` : Communicator with graph topology added (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -105,9 +105,9 @@ Process Neighbors Then, the input arguments are: -- nodes = 4 -- index = 2, 3, 4, 6 -- edges = 1, 3, 0, 3, 0, 2 +* nodes = 4 +* index = 2, 3, 4, 6 +* edges = 1, 3, 0, 3, 0, 2 Thus, in C, index[0] is the degree of node zero, and index[i] - index[i-1] is the degree of node i, i=1, . . . , nnodes-1; the list of diff --git a/docs/man-openmpi/man3/MPI_Graph_get.3.rst b/docs/man-openmpi/man3/MPI_Graph_get.3.rst index d3038f53352..e6fe77e9cf4 100644 --- a/docs/man-openmpi/man3/MPI_Graph_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_get.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -36,7 +36,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -49,17 +49,17 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Communicator with graph structure (handle). -- maxindex : Length of vector index in the calling program (integer). -- maxedges : Length of vector edges in the calling program (integer). +* ``comm`` : Communicator with graph structure (handle). +* ``maxindex`` : Length of vector index in the calling program (integer). +* ``maxedges`` : Length of vector edges in the calling program (integer). OUTPUT PARAMETERS ----------------- -- index : Array of integers containing the graph structure (for details +* ``index`` : Array of integers containing the graph structure (for details see the definition of MPI_Graph_create). -- edges : Array of integers containing the graph structure. -- IERROR : Fortran only: Error status (integer). +* ``edges`` : Array of integers containing the graph structure. +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Graph_map.3.rst b/docs/man-openmpi/man3/MPI_Graph_map.3.rst index 7a75269daae..1d4bd3d730f 100644 --- a/docs/man-openmpi/man3/MPI_Graph_map.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_map.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,18 +47,18 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Input communicator (handle). -- nnodes : Number of graph nodes (integer). -- index : Integer array specifying the graph structure, see +* ``comm`` : Input communicator (handle). +* ``nnodes`` : Number of graph nodes (integer). +* ``index`` : Integer array specifying the graph structure, see :ref:`MPI_Graph_create`. -- edges : Integer array specifying the graph structure. +* ``edges`` : Integer array specifying the graph structure. OUTPUT PARAMETERS ----------------- -- newrank : Reordered rank of the calling process; MPI_UNDEFINED if the +* ``newrank`` : Reordered rank of the calling process; MPI_UNDEFINED if the calling process does not belong to graph (integer). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst b/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst index 2fd35ea4530..badcc89c9df 100644 --- a/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_neighbors.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``neighbors``: Ranks of processes that are neighbors to specified process (array of integers). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -88,21 +88,21 @@ Suppose that the communicator comm has this topology associated with it. The following code fragment cycles through the three types of neighbors and performs an appropriate permutation for each. -:: +.. code-block:: fortran - C assume: each process has stored a real number A. - C extract neighborhood information - CALL MPI_COMM_RANK(comm, myrank, ierr) - CALL MPI_GRAPH_NEIGHBORS(comm, myrank, 3, neighbors, ierr) - C perform exchange permutation - CALL MPI_SENDRECV_REPLACE(A, 1, MPI_REAL, neighbors(1), 0, - + neighbors(1), 0, comm, status, ierr) - C perform shuffle permutation - CALL MPI_SENDRECV_REPLACE(A, 1, MPI_REAL, neighbors(2), 0, - + neighbors(3), 0, comm, status, ierr) - C perform unshuffle permutation - CALL MPI_SENDRECV_REPLACE(A, 1, MPI_REAL, neighbors(3), 0, - + neighbors(2), 0, comm, status, ierr) + ! assume: each process has stored a real number A. + ! extract neighborhood information + CALL MPI_COMM_RANK(comm, myrank, ierr) + CALL MPI_GRAPH_NEIGHBORS(comm, myrank, 3, neighbors, ierr) + ! perform exchange permutation + CALL MPI_SENDRECV_REPLACE(A, 1, MPI_REAL, neighbors(1), 0, & + neighbors(1), 0, comm, status, ierr) + ! perform shuffle permutation + CALL MPI_SENDRECV_REPLACE(A, 1, MPI_REAL, neighbors(2), 0, & + neighbors(3), 0, comm, status, ierr) + ! perform unshuffle permutation + CALL MPI_SENDRECV_REPLACE(A, 1, MPI_REAL, neighbors(3), 0, & + neighbors(2), 0, comm, status, ierr) ERRORS @@ -111,4 +111,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Graph_neighbors_count` + * :ref:`MPI_Graph_neighbors_count` 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 3607c0dc111..229f5d9d81b 100644 --- a/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst +++ b/docs/man-openmpi/man3/MPI_Graph_neighbors_count.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,14 +48,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- comm : Communicator with graph topology (handle). -- rank : Rank of process in group of comm (integer). +* ``comm`` : Communicator with graph topology (handle). +* ``rank`` : Rank of process in group of comm (integer). OUTPUT PARAMETERS ----------------- -- nneighbors : Number of neighbors of specified process (integer). -- IERROR : Fortran only: Error status (integer). +* ``nneighbors`` : Number of neighbors of specified process (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst b/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst index c23a85721e4..60c3b846e54 100644 --- a/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Graphdims_get.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,14 +46,14 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- comm : Communicator for group with graph structure (handle). +* ``comm`` : Communicator for group with graph structure (handle). OUTPUT PARAMETERS ----------------- -- nnodes : Number of nodes in graph (integer). -- nedges : Number of edges in graph (integer). -- IERROR : Fortran only: Error status (integer). +* ``nnodes`` : Number of nodes in graph (integer). +* ``nedges`` : Number of edges in graph (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst b/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst index cc92da9beb9..48b13b06220 100644 --- a/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst +++ b/docs/man-openmpi/man3/MPI_Grequest_complete.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,12 +45,12 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ---------------------- -- ``request`` : Generalized request (handle). +* ``request`` : Generalized request (handle). OUTPUT PARAMETER ---------------- -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst index ab6de265b43..564e9489c98 100644 --- a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst +++ b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -26,7 +26,7 @@ C Syntax Fortran Syntax (See Fortran 77 Notes) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -40,7 +40,7 @@ Fortran Syntax (See Fortran 77 Notes) Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -56,19 +56,19 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``query_fn`` : Callback function invoked when request status is +* ``query_fn`` : Callback function invoked when request status is queried (function). -- ``free_fn`` : Callback function invoked when request is freed +* ``free_fn`` : Callback function invoked when request is freed (function). -- ``cancel_fn`` : Callback function invoked when request is canceled +* ``cancel_fn`` : Callback function invoked when request is canceled (function). -- ``extra_state`` : Extra state. +* ``extra_state`` : Extra state. OUTPUT PARAMETERS ----------------- -- ``request`` : Generalized request (handle). -- ``IERROR`` : Fortran only: Error status (integer). +* ``request`` : Generalized request (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -82,14 +82,14 @@ associated with the ``request`` by the starting call :ref:`MPI_Grequest_start`. This can be used to maintain user-defined state for the ``request``. In C, the query function is -.. code:: c +.. code-block:: c typedef int MPI_Grequest_query_function(void *extra_state, MPI_Status *status); In Fortran, it is -.. code:: fortran +.. code-block:: fortran SUBROUTINE GREQUEST_QUERY_FUNCTION(EXTRA_STATE, STATUS, IERROR) INTEGER STATUS(MPI_STATUS_SIZE), IERROR @@ -120,13 +120,13 @@ specified by MPI. In C, the free function is -.. code:: c +.. code-block:: c typedef int MPI_Grequest_free_function(void *extra_state); And in Fortran, it is -.. code:: fortran +.. code-block:: fortran SUBROUTINE GREQUEST_FREE_FUNCTION(EXTRA_STATE, IERROR) INTEGER IERROR @@ -156,13 +156,13 @@ by a correct program. In C, the cancel function is -.. code:: c +.. code-block:: c typedef int MPI_Grequest_cancel_function(void *extra_state, int complete); In Fortran, the cancel function is -.. code:: Fortran +.. code-block:: Fortran SUBROUTINE GREQUEST_CANCEL_FUNCTION(EXTRA_STATE, COMPLETE, IERROR) INTEGER IERROR @@ -182,11 +182,11 @@ The MPI standard prescribes portable Fortran syntax for the ``EXTRA_STATE`` argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -.. code:: fortran +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND EXTRA_STATE -where ``MPI_ADDRESS_KIND`` is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. ERRORS diff --git a/docs/man-openmpi/man3/MPI_Group_compare.3.rst b/docs/man-openmpi/man3/MPI_Group_compare.3.rst index 41842dc658c..13b19633627 100644 --- a/docs/man-openmpi/man3/MPI_Group_compare.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_compare.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,16 +46,16 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- ``group1`` : First group (handle). -- ``group2`` : Second group (handle). +* ``group1`` : First group (handle). +* ``group2`` : Second group (handle). OUTPUT PARAMETERS ----------------- -- ``result`` : Integer which is MPI_IDENT if the order and members of +* ``result`` : Integer which is MPI_IDENT if the order and members of the two groups are the same, MPI_SIMILAR if only the members are the same, and MPI_UNEQUAL otherwise. -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Group_difference.3.rst b/docs/man-openmpi/man3/MPI_Group_difference.3.rst index a0d60b4c577..2cad3cd8287 100644 --- a/docs/man-openmpi/man3/MPI_Group_difference.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_difference.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,25 +46,25 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- group1 : First group (handle). -- group2 : Second group (handle). +* ``group1`` : First group (handle). +* ``group2`` : Second group (handle). OUTPUT PARAMETERS ----------------- -- newgroup : Difference group (handle). -- IERROR : Fortran only: Error status (integer). +* ``newgroup`` : Difference group (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- The set-like operations are defined as follows: -- union -- All elements of the first group (group1), followed by all +* union -- 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 -- 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 -- 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 4595b9b9760..4081b6abd56 100644 --- a/docs/man-openmpi/man3/MPI_Group_excl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_excl.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,16 +48,16 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- group : Group (handle). -- n : Number of elements in array ranks (integer). -- ranks : Array of integer ranks in group not to appear in newgroup. +* ``group`` : Group (handle). +* ``n`` : Number of elements in array ranks (integer). +* ``ranks`` : Array of integer ranks in group not to appear in newgroup. OUTPUT PARAMETERS ----------------- -- newgroup : New group derived from above, preserving the order defined +* ``newgroup`` : New group derived from above, preserving the order defined by group (handle). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Group_free.3.rst b/docs/man-openmpi/man3/MPI_Group_free.3.rst index eeabc53855a..4f31fe0e5e9 100644 --- a/docs/man-openmpi/man3/MPI_Group_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_free.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -44,12 +44,12 @@ Fortran 2008 Syntax INPUT/OUTPUT PARAMETER ---------------------- -- ``group`` : Group (handle). +* ``group`` : Group (handle). OUTPUT PARAMETER ---------------- -- ``IERROR`` : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 ea480ef2b76..e4da04f80c3 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 @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,16 +48,16 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- session : Session (handle). -- pset_name : name of process set to use to create the new group +* ``session`` : Session (handle). +* ``pset_name`` : name of process set to use to create the new group (string) OUTPUT PARAMETERS ----------------- -- newgroup : New group derived from supplied session and process set +* ``newgroup`` : New group derived from supplied session and process set (handle). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Group_incl.3.rst b/docs/man-openmpi/man3/MPI_Group_incl.3.rst index 3496cb28f88..b5fd771aa71 100644 --- a/docs/man-openmpi/man3/MPI_Group_incl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_incl.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,18 +48,18 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- group : Group (handle). -- n : Number of elements in array ranks (and size of +* ``group`` : Group (handle). +* ``n`` : Number of elements in array ranks (and size of newgroup)(integer). -- ranks : Ranks of processes in group to appear in newgroup (array of +* ``ranks`` : Ranks of processes in group to appear in newgroup (array of integers). OUTPUT PARAMETERS ----------------- -- newgroup : New group derived from above, in the order defined by +* ``newgroup`` : New group derived from above, in the order defined by ranks (handle). -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Group_intersection.3.rst b/docs/man-openmpi/man3/MPI_Group_intersection.3.rst index 88ce26543ba..b664d27e1a4 100644 --- a/docs/man-openmpi/man3/MPI_Group_intersection.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_intersection.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,25 +47,25 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- group1 : First group (handle). -- group2 : Second group (handle). +* ``group1`` : First group (handle). +* ``group2`` : Second group (handle). OUTPUT PARAMETERS ----------------- -- newgroup : Intersection group (handle). -- IERROR : Fortran only: Error status (integer). +* ``newgroup`` : Intersection group (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- The set-like operations are defined as follows: -- union -- All elements of the first group (group1), followed by all +* union -- 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 -- 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 -- 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 3501ecfbbcb..49262f863cd 100644 --- a/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_range_excl.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newgroup``: New group derived from above, preserving the order in group (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -80,4 +80,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Group_excl` :ref:`MPI_Group_free` + * :ref:`MPI_Group_excl` + * :ref:`MPI_Group_free` 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 8617bd7de53..4e38690a528 100644 --- a/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_range_incl.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newgroup``: New group derived from above, in the order defined by ranges (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -107,4 +107,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Group_incl` :ref:`MPI_Group_free` + * :ref:`MPI_Group_incl` + * :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Group_rank.3.rst b/docs/man-openmpi/man3/MPI_Group_rank.3.rst index 61b9b687b87..43415f10d6d 100644 --- a/docs/man-openmpi/man3/MPI_Group_rank.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_rank.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``rank``: Rank of the calling process in group, or MPI_UNDEFINED if the process is not a member (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Group_size.3.rst b/docs/man-openmpi/man3/MPI_Group_size.3.rst index 80fae554904..e8cf2ffaeaf 100644 --- a/docs/man-openmpi/man3/MPI_Group_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_size.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``size``: Number of processes in the group (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 fbe3fb5fbe6..70e893779df 100644 --- a/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_translate_ranks.3.rst @@ -60,7 +60,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``ranks2``: Array of corresponding ranks in group2, MPI_UNDEFINED when no correspondence exists. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Group_union.3.rst b/docs/man-openmpi/man3/MPI_Group_union.3.rst index d1fc92de9cf..7087154824f 100644 --- a/docs/man-openmpi/man3/MPI_Group_union.3.rst +++ b/docs/man-openmpi/man3/MPI_Group_union.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newgroup``: Union group (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -82,4 +82,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Group_free` + * :ref:`MPI_Group_free` diff --git a/docs/man-openmpi/man3/MPI_Ibsend.3.rst b/docs/man-openmpi/man3/MPI_Ibsend.3.rst index 1b68f86546d..5a5f92765b3 100644 --- a/docs/man-openmpi/man3/MPI_Ibsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Ibsend.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -85,4 +85,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Test` :ref:`MPI_Wait` + * :ref:`MPI_Test` + * :ref:`MPI_Wait` diff --git a/docs/man-openmpi/man3/MPI_Improbe.3.rst b/docs/man-openmpi/man3/MPI_Improbe.3.rst index 5176d65a61e..a15d7588521 100644 --- a/docs/man-openmpi/man3/MPI_Improbe.3.rst +++ b/docs/man-openmpi/man3/MPI_Improbe.3.rst @@ -54,8 +54,8 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``source``: Source rank or MPI_ANY_SOURCE (integer). -* ``tag``: Tag value or MPI_ANY_TAG (integer). +* ``source``: Source rank or ``MPI_ANY_SOURCE`` (integer). +* ``tag``: Tag value or ``MPI_ANY_TAG`` (integer). * ``comm``: Communicator (handle). OUTPUT PARAMETERS @@ -63,7 +63,7 @@ OUTPUT PARAMETERS * ``flag``: Flag (logical). * ``message``: Message (handle). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,14 +77,14 @@ to decide how to receive the message, based on the information returned by the probe. In particular, the application may allocate memory for the receive buffer according to the length of the probed message. -A matching probe with MPI_PROC_NULL as *source* returns *flag* = true, +A matching probe with ``MPI_PROC_NULL`` as *source* returns *flag* = true, -*message* = MPI_MESSAGE_NO_PROC, and the *status* object returns source -^ MPI_PROC_NULL, tag ^ MPI_ANY_TAG, and count ^ 0. +*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 and can be received by passing the *message* handle to the :ref:`MPI_Mrecv` or -:ref:`MPI_Imrecv` functions, provided the *source* was not MPI_PROC_NULL. +:ref:`MPI_Imrecv` functions, provided the *source* was not ``MPI_PROC_NULL``. ERRORS @@ -93,4 +93,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Mprobe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Mrecv` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` + * :ref:`MPI_Mprobe` + * :ref:`MPI_Probe` + * :ref:`MPI_Iprobe` + * :ref:`MPI_Mrecv` + * :ref:`MPI_Imrecv` + * :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Imrecv.3.rst b/docs/man-openmpi/man3/MPI_Imrecv.3.rst index 0da440f718c..2bc46c6dd17 100644 --- a/docs/man-openmpi/man3/MPI_Imrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Imrecv.3.rst @@ -61,7 +61,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of receive buffer (choice). * ``request``: Request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,8 +74,8 @@ The *request* returned from :ref:`MPI_Imrecv` can be used with any of the 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 +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 reception of a matched message is started with :ref:`MPI_Imrecv`, then it is @@ -97,4 +97,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Mprobe` :ref:`MPI_Improbe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` + * :ref:`MPI_Mprobe` + * :ref:`MPI_Improbe` + * :ref:`MPI_Probe` + * :ref:`MPI_Iprobe` + * :ref:`MPI_Imrecv` + * :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Info_create.3.rst b/docs/man-openmpi/man3/MPI_Info_create.3.rst index a9afe731e19..a287a05e397 100644 --- a/docs/man-openmpi/man3/MPI_Info_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_create.3.rst @@ -48,7 +48,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``info``: Info object created (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -63,4 +63,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_set` 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 f590559a586..45e9895c96d 100644 --- a/docs/man-openmpi/man3/MPI_Info_create_env.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_create_env.3.rst @@ -49,7 +49,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``info``: Info object created (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -68,4 +68,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_delete.3.rst b/docs/man-openmpi/man3/MPI_Info_delete.3.rst index 66ea290925b..ebc77a06099 100644 --- a/docs/man-openmpi/man3/MPI_Info_delete.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_delete.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,4 +72,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_create` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_dup.3.rst b/docs/man-openmpi/man3/MPI_Info_dup.3.rst index 4137f29cc32..737798230fe 100644 --- a/docs/man-openmpi/man3/MPI_Info_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_dup.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``newinfo``: Info object (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -68,4 +68,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_free` :ref:`MPI_Info_get` :ref:`MPI_Info_set` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_env.3.rst b/docs/man-openmpi/man3/MPI_Info_env.3.rst index 777fce9e27e..b672c741f66 100644 --- a/docs/man-openmpi/man3/MPI_Info_env.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_env.3.rst @@ -93,4 +93,4 @@ ERRORS .. seealso:: - :ref:`MPI_Info_get` + * :ref:`MPI_Info_get` diff --git a/docs/man-openmpi/man3/MPI_Info_free.3.rst b/docs/man-openmpi/man3/MPI_Info_free.3.rst index 453ce188804..d9b082b54b2 100644 --- a/docs/man-openmpi/man3/MPI_Info_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_free.3.rst @@ -51,7 +51,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,4 +65,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_get` :ref:`MPI_Info_set` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Info_get.3.rst b/docs/man-openmpi/man3/MPI_Info_get.3.rst index 651a5f1860e..7aaef7a0975 100644 --- a/docs/man-openmpi/man3/MPI_Info_get.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get.3.rst @@ -62,7 +62,7 @@ OUTPUT PARAMETER ---------------- * ``value``: Value (string). * ``flag``: Returns true if key defined, false if not (boolean). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,6 +84,11 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` - :ref:`MPI_Info_get_valuelen` :ref:`MPI_Info_get_nkeys` :ref:`MPI_Info_get_nthkey` - :ref:`MPI_Info_set` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_get_valuelen` + * :ref:`MPI_Info_get_nkeys` + * :ref:`MPI_Info_get_nthkey` + * :ref:`MPI_Info_set` 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 03daf724ef6..6c859cfbec6 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_nkeys.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``nkeys``: Number of defined keys (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -69,4 +69,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_get` :ref:`MPI_Info_get_nthkey` :ref:`MPI_Info_get_valuelen` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_get_nthkey` + * :ref:`MPI_Info_get_valuelen` 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 dfd0e3b8f75..a5810c843f1 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_nthkey.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``key``: Key (string). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,4 +74,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_get` :ref:`MPI_Info_get_nkeys` :ref:`MPI_Info_get_valuelen` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_get_nkeys` + * :ref:`MPI_Info_get_valuelen` 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 5ed3f7e9435..fddd75e0b35 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_string.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_string.3.rst @@ -62,7 +62,7 @@ OUTPUT PARAMETER * ``buflen On entry, length of value arg. On return, set to required size to``: hold value string (integer). * ``value``: Value (string). * ``flag``: Returns true if key defined, false if not (boolean). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -90,5 +90,10 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` - :ref:`MPI_Info_get_nkeys` :ref:`MPI_Info_get_nthkey` :ref:`MPI_Info_set` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_get_nkeys` + * :ref:`MPI_Info_get_nthkey` + * :ref:`MPI_Info_set` 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 c4b15c56452..6d8d9456499 100644 --- a/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_get_valuelen.3.rst @@ -61,7 +61,7 @@ OUTPUT PARAMETERS ----------------- * ``valuelen``: Length of value arg (integer). * ``flag``: Returns true if key defined, false if not (boolean). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -81,4 +81,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_get` :ref:`MPI_Info_get_nkeys` :ref:`MPI_Info_get_nthkey` + * :ref:`MPI_Info_get` + * :ref:`MPI_Info_get_nkeys` + * :ref:`MPI_Info_get_nthkey` diff --git a/docs/man-openmpi/man3/MPI_Info_set.3.rst b/docs/man-openmpi/man3/MPI_Info_set.3.rst index 7fd95136472..8162b8c3caa 100644 --- a/docs/man-openmpi/man3/MPI_Info_set.3.rst +++ b/docs/man-openmpi/man3/MPI_Info_set.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,4 +77,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Info_create` :ref:`MPI_Info_delete` :ref:`MPI_Info_dup` :ref:`MPI_Info_free` :ref:`MPI_Info_set` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_delete` + * :ref:`MPI_Info_dup` + * :ref:`MPI_Info_free` + * :ref:`MPI_Info_set` diff --git a/docs/man-openmpi/man3/MPI_Init.3.rst b/docs/man-openmpi/man3/MPI_Init.3.rst index 75d8df5e86f..ffa0f0891bb 100644 --- a/docs/man-openmpi/man3/MPI_Init.3.rst +++ b/docs/man-openmpi/man3/MPI_Init.3.rst @@ -51,7 +51,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,15 +65,13 @@ All MPI programs must contain a call to :ref:`MPI_Init` or :ref:`MPI_Init_thread Open MPI accepts the C *argc* and *argv* arguments to main, but neither modifies, interprets, nor distributes them: -:: +.. code-block:: c - { - /* declare variables */ - MPI_Init(&argc, &argv); - /* parse arguments */ - /* main program */ - MPI_Finalize(); - } + /* declare variables */ + MPI_Init(&argc, &argv); + /* parse arguments */ + /* main program */ + MPI_Finalize(); NOTES @@ -95,4 +93,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Init_thread` :ref:`MPI_Initialized` :ref:`MPI_Finalize` :ref:`MPI_Finalized` + * :ref:`MPI_Init_thread` + * :ref:`MPI_Initialized` + * :ref:`MPI_Finalize` + * :ref:`MPI_Finalized` diff --git a/docs/man-openmpi/man3/MPI_Init_thread.3.rst b/docs/man-openmpi/man3/MPI_Init_thread.3.rst index f5461326c20..ceea9cb8ca6 100644 --- a/docs/man-openmpi/man3/MPI_Init_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_Init_thread.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``provided``: Available level of thread support (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -96,15 +96,13 @@ All MPI programs must contain a call to :ref:`MPI_Init` or :ref:`MPI_Init_thread Open MPI accepts the C *argc* and *argv* arguments to main, but neither modifies, interprets, nor distributes them: -:: +.. code-block:: c - { - /* declare variables */ - MPI_Init_thread(&argc, &argv, req, &prov); - /* parse arguments */ - /* main program */ - MPI_Finalize(); - } + /* declare variables */ + MPI_Init_thread(&argc, &argv, req, &prov); + /* parse arguments */ + /* main program */ + MPI_Finalize(); NOTES @@ -150,4 +148,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Init` :ref:`MPI_Initialized` :ref:`MPI_Finalize` :ref:`MPI_Finalized` + * :ref:`MPI_Init` + * :ref:`MPI_Initialized` + * :ref:`MPI_Finalize` + * :ref:`MPI_Finalized` diff --git a/docs/man-openmpi/man3/MPI_Initialized.3.rst b/docs/man-openmpi/man3/MPI_Initialized.3.rst index e12b746bf4e..65f222e6cda 100644 --- a/docs/man-openmpi/man3/MPI_Initialized.3.rst +++ b/docs/man-openmpi/man3/MPI_Initialized.3.rst @@ -49,7 +49,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``flag``: True if MPI has been initialized, and false otherwise (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,4 +65,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Init` :ref:`MPI_Init_thread` :ref:`MPI_Finalize` :ref:`MPI_Finalized` + * :ref:`MPI_Init` + * :ref:`MPI_Init_thread` + * :ref:`MPI_Finalize` + * :ref:`MPI_Finalized` diff --git a/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst index 59af03b42c6..8b73fa57686 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_create.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newintercomm``: Created intercommunicator (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -105,5 +105,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Intercomm_merge` :ref:`MPI_Comm_free` :ref:`MPI_Comm_remote_group` - :ref:`MPI_Comm_remote_size` + * :ref:`MPI_Intercomm_merge` + * :ref:`MPI_Comm_free` + * :ref:`MPI_Comm_remote_group` + * :ref:`MPI_Comm_remote_size` 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 7cfcb793bfa..b6495f90692 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 @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -51,21 +51,21 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- local_group : Local group (handler) -- local_leader : rank of local group leader in local_group (integer) -- remote_group : Remote group (handler) -- remote_leader : rank of remote leader in remote_group, significant +* ``local_group`` : Local group (handler) +* ``local_leader`` : rank of local group leader in local_group (integer) +* ``remote_group`` : Remote group (handler) +* ``remote_leader`` : rank of remote leader in remote_group, significant only at local_leader (integer) -- stringtag : Unique identifier for this operation (string) -- info : info object (handler) -- errhandler : error handler to be attached to the new +* ``stringtag`` : Unique identifier for this operation (string) +* ``info`` : info object (handler) +* ``errhandler`` : error handler to be attached to the new inter-communicator (handle) OUTPUT PARAMETERS ----------------- -- newintercomm : New inter-communicator (handle). -- IERROR : Fortran only: Error status (integer). +* ``newintercomm`` : New inter-communicator (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst b/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst index 813bbdc6ac1..e7d95f33d50 100644 --- a/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst +++ b/docs/man-openmpi/man3/MPI_Intercomm_merge.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newintracomm``: Created intracommunicator (type indicator). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -79,4 +79,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Intercomm_create` :ref:`MPI_Comm_free` + * :ref:`MPI_Intercomm_create` + * :ref:`MPI_Comm_free` diff --git a/docs/man-openmpi/man3/MPI_Iprobe.3.rst b/docs/man-openmpi/man3/MPI_Iprobe.3.rst index bb672240943..9eb65607362 100644 --- a/docs/man-openmpi/man3/MPI_Iprobe.3.rst +++ b/docs/man-openmpi/man3/MPI_Iprobe.3.rst @@ -52,15 +52,15 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``source``: Source rank or MPI_ANY_SOURCE (integer). -* ``tag``: Tag value or MPI_ANY_TAG (integer). +* ``source``: Source rank or ``MPI_ANY_SOURCE`` (integer). +* ``tag``: Tag value or ``MPI_ANY_TAG`` (integer). * ``comm``: Communicator (handle). OUTPUT PARAMETERS ----------------- * ``flag``: Message-waiting flag (logical). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,13 +72,13 @@ 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 +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 -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 @@ -92,13 +92,13 @@ matched by the probe if no other intervening receive occurs after the probe. If the receiving process is multithreaded, it is the user's responsibility to ensure that the last condition holds. -The source argument of :ref:`MPI_Probe` can be MPI_ANY_SOURCE, and the tag -argument can be MPI_ANY_TAG, so that one can probe for messages from an +The source argument of :ref:`MPI_Probe` can be ``MPI_ANY_SOURCE``, and the tag +argument can be ``MPI_ANY_TAG``, so that one can probe for messages from an arbitrary source and/or with an arbitrary tag. However, a specific communication context must be provided with the comm argument. 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. It is not necessary to receive a message immediately after it has been @@ -119,4 +119,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Probe` :ref:`MPI_Cancel` + * :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 0ae2e2bf738..289486b7eec 100644 --- a/docs/man-openmpi/man3/MPI_Irecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Irecv.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -90,4 +90,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Recv` :ref:`MPI_Probe` :ref:`MPI_Test` :ref:`MPI_Testany` :ref:`MPI_Wait` :ref:`MPI_Waitany` + * :ref:`MPI_Recv` + * :ref:`MPI_Probe` + * :ref:`MPI_Test` + * :ref:`MPI_Testany` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitany` diff --git a/docs/man-openmpi/man3/MPI_Irsend.3.rst b/docs/man-openmpi/man3/MPI_Irsend.3.rst index ecfe69d4113..8c52eed0de2 100644 --- a/docs/man-openmpi/man3/MPI_Irsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Irsend.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -85,4 +85,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Rsend` + * :ref:`MPI_Rsend` 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 033fb44409d..b0b175b68ad 100644 --- a/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst +++ b/docs/man-openmpi/man3/MPI_Is_thread_main.3.rst @@ -49,7 +49,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``flag``: True if calling thread is main thread (boolean). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,4 +65,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Init` :ref:`MPI_Init_thread` + * :ref:`MPI_Init` + * :ref:`MPI_Init_thread` diff --git a/docs/man-openmpi/man3/MPI_Isend.3.rst b/docs/man-openmpi/man3/MPI_Isend.3.rst index 7d9d94143bf..119cc3b5dc4 100644 --- a/docs/man-openmpi/man3/MPI_Isend.3.rst +++ b/docs/man-openmpi/man3/MPI_Isend.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -89,4 +89,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Send` :ref:`MPI_Wait` :ref:`MPI_Waitany` :ref:`MPI_Test` :ref:`MPI_Testany` + * :ref:`MPI_Send` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitany` + * :ref:`MPI_Test` + * :ref:`MPI_Testany` diff --git a/docs/man-openmpi/man3/MPI_Isendrecv.3.rst b/docs/man-openmpi/man3/MPI_Isendrecv.3.rst index 1f4c3482bcd..582b3d0e68e 100644 --- a/docs/man-openmpi/man3/MPI_Isendrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Isendrecv.3.rst @@ -77,7 +77,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Initial address of receive buffer (choice). * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -111,4 +111,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Isendrecv_replace` :ref:`MPI_Sendrecv` :ref:`MPI_Sendrecv_replace` + * :ref:`MPI_Isendrecv_replace` + * :ref:`MPI_Sendrecv` + * :ref:`MPI_Sendrecv_replace` diff --git a/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst b/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst index 65d5038fb45..47e77ed7864 100644 --- a/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst +++ b/docs/man-openmpi/man3/MPI_Isendrecv_replace.3.rst @@ -74,7 +74,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -108,4 +108,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Isendrecv` :ref:`MPI_Sendrecv` :ref:`MPI_Sendrecv_replace` + * :ref:`MPI_Isendrecv` + * :ref:`MPI_Sendrecv` + * :ref:`MPI_Sendrecv_replace` diff --git a/docs/man-openmpi/man3/MPI_Issend.3.rst b/docs/man-openmpi/man3/MPI_Issend.3.rst index 778fc0976bf..c1303136ab2 100644 --- a/docs/man-openmpi/man3/MPI_Issend.3.rst +++ b/docs/man-openmpi/man3/MPI_Issend.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -87,4 +87,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Ssend` + * :ref:`MPI_Ssend` diff --git a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst index 991b62fe5c3..6a2f7deabf6 100644 --- a/docs/man-openmpi/man3/MPI_Keyval_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Keyval_create.3.rst @@ -45,7 +45,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``keyval``: Key value for future access (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -62,7 +62,7 @@ The copy_fn function is invoked when a communicator is duplicated by :ref:`MPI_COMM_DUP`. copy_fn should be of type MPI_Copy_function, which is defined as follows: -:: +.. code-block:: c typedef int MPI_Copy_function(MPI_Comm oldcomm, int keyval, void *extra_state, void *attribute_val_in, @@ -108,7 +108,7 @@ Even though both formal arguments attribute_val_in and attribute_val_out are of type void*, their usage differs. The C copy function is passed by MPI in attribute_val_in the value of the attribute, and in attribute_val_out the address of the attribute, so as to allow the -function to return the (new) attribute value. The use of type void\* for +function to return the (new) attribute value. The use of type ``void *`` for both is to avoid messy type casts. A valid copy function is one that completely duplicates the information @@ -124,7 +124,7 @@ deleted by :ref:`MPI_Comm_free` or when a call is made explicitly to :ref:`MPI_Attr_delete`. delete_fn should be of type MPI_Delete_function, which is defined as follows: -:: +.. code-block:: c typedef int MPI_Delete_function(MPI_Comm comm, int keyval, void *attribute_val, void *extra_state); @@ -156,4 +156,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Keyval_free` :ref:`MPI_Comm_create_keyval` + * :ref:`MPI_Keyval_free` + * :ref:`MPI_Comm_create_keyval` diff --git a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst index 0421cc80f15..96cdd0f4d8c 100644 --- a/docs/man-openmpi/man3/MPI_Keyval_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Keyval_free.3.rst @@ -40,7 +40,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -70,4 +70,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Keyval_create` :ref:`MPI_Comm_free_keyval` + * :ref:`MPI_Keyval_create` + * :ref:`MPI_Comm_free_keyval` diff --git a/docs/man-openmpi/man3/MPI_Lookup_name.3.rst b/docs/man-openmpi/man3/MPI_Lookup_name.3.rst index 946ac4bcb9f..c5ba9b52dee 100644 --- a/docs/man-openmpi/man3/MPI_Lookup_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Lookup_name.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``port_name``: a port name (string). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -124,4 +124,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Publish_name` :ref:`MPI_Open_port` + * :ref:`MPI_Publish_name` + * :ref:`MPI_Open_port` diff --git a/docs/man-openmpi/man3/MPI_Mprobe.3.rst b/docs/man-openmpi/man3/MPI_Mprobe.3.rst index e1137fd7fc8..3fc818fceca 100644 --- a/docs/man-openmpi/man3/MPI_Mprobe.3.rst +++ b/docs/man-openmpi/man3/MPI_Mprobe.3.rst @@ -52,15 +52,15 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``source``: Source rank or MPI_ANY_SOURCE (integer). -* ``tag``: Tag value or MPI_ANY_TAG (integer). +* ``source``: Source rank or ``MPI_ANY_SOURCE`` (integer). +* ``tag``: Tag value or ``MPI_ANY_TAG`` (integer). * ``comm``: Communicator (handle). OUTPUT PARAMETERS ----------------- * ``message``: Message (handle). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,11 +74,11 @@ to decide how to receive the message, based on the information returned by the probe. In particular, the application may allocate memory for the receive buffer according to the length of the probed message. -A matching probe with MPI_PROC_NULL as *source* returns *message* = -MPI_MESSAGE_NO_PROC, and the *status* object returns source = -MPI_PROC_NULL, tag = MPI_ANY_TAG, and count = 0. +A matching probe with ``MPI_PROC_NULL`` as *source* returns *message* = +``MPI_MESSAGE_NO_PROC``, and the *status* object returns source = +``MPI_PROC_NULL``, tag = ``MPI_ANY_TAG``, and count = 0. -When :ref:`MPI_Mprobe` returns (from a non-MPI_PROC_NULL *source*), the matched +When :ref:`MPI_Mprobe` returns (from a non-``MPI_PROC_NULL`` *source*), the matched message can then be received by passing the *message* handle to the :ref:`MPI_Mrecv` or :ref:`MPI_Imrecv` functions. @@ -89,4 +89,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Improbe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Mrecv` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` + * :ref:`MPI_Improbe` + * :ref:`MPI_Probe` + * :ref:`MPI_Iprobe` + * :ref:`MPI_Mrecv` + * :ref:`MPI_Imrecv` + * :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Mrecv.3.rst b/docs/man-openmpi/man3/MPI_Mrecv.3.rst index 44121334580..4e84ff5422b 100644 --- a/docs/man-openmpi/man3/MPI_Mrecv.3.rst +++ b/docs/man-openmpi/man3/MPI_Mrecv.3.rst @@ -62,7 +62,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of receive buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,8 +72,8 @@ previously matched by a matching probe. 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. +``MPI_PROC_NULL``, *tag* = ``MPI_ANY_TAG``, and *count* = 0, as if a receive +from ``MPI_PROC_NULL`` was issued. ERRORS @@ -82,4 +82,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Mprobe` :ref:`MPI_Improbe` :ref:`MPI_Probe` :ref:`MPI_Iprobe` :ref:`MPI_Imrecv` :ref:`MPI_Cancel` + * :ref:`MPI_Mprobe` + * :ref:`MPI_Improbe` + * :ref:`MPI_Probe` + * :ref:`MPI_Iprobe` + * :ref:`MPI_Imrecv` + * :ref:`MPI_Cancel` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst index 987421b1baf..0a45ed74d70 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgather.3.rst @@ -112,7 +112,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -146,11 +146,11 @@ sources and destinations in the communication routines are 2*ndims with ndims defined in :ref:`MPI_Cart_create`. If a neighbor does not exist, i.e., at the border of a Cartesian topology in the case of a non-periodic virtual grid dimension (i.e., periods[...]==false), then this neighbor is -defined to be MPI_PROC_NULL. +defined to be ``MPI_PROC_NULL``. -If a neighbor in any of the functions is MPI_PROC_NULL, then the +If a neighbor in any of the functions is ``MPI_PROC_NULL``, then the neighborhood collective communication behaves like a point-to-point -communication with MPI_PROC_NULL in this direction. That is, the buffer +communication with ``MPI_PROC_NULL`` in this direction. That is, the buffer is still part of the sequence of neighbors but it is neither communicated nor updated. @@ -168,5 +168,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Neighbor_allgatherv` :ref:`MPI_Cart_create` MPI_Garph_create - :ref:`MPI_Dist_graph_create` :ref:`MPI_Gather` + * :ref:`MPI_Neighbor_allgatherv` + * :ref:`MPI_Cart_create` + * MPI_Garph_create + * :ref:`MPI_Dist_graph_create` + * :ref:`MPI_Gather` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst index a0b36378150..8d38287dfea 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_allgatherv.3.rst @@ -118,7 +118,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -155,11 +155,11 @@ sources and destinations in the communication routines are 2*ndims with ndims defined in :ref:`MPI_Cart_create`. If a neighbor does not exist, i.e., at the border of a Cartesian topology in the case of a non-periodic virtual grid dimension (i.e., periods[...]==false), then this neighbor is -defined to be MPI_PROC_NULL. +defined to be ``MPI_PROC_NULL``. -If a neighbor in any of the functions is MPI_PROC_NULL, then the +If a neighbor in any of the functions is ``MPI_PROC_NULL``, then the neighborhood collective communication behaves like a point-to-point -communication with MPI_PROC_NULL in this direction. That is, the buffer +communication with ``MPI_PROC_NULL`` in this direction. That is, the buffer is still part of the sequence of neighbors but it is neither communicated nor updated. @@ -177,5 +177,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Neighbor_allgather` :ref:`MPI_Cart_create` :ref:`MPI_Graph_create` - :ref:`MPI_Dist_graph_create` + * :ref:`MPI_Neighbor_allgather` + * :ref:`MPI_Cart_create` + * :ref:`MPI_Graph_create` + * :ref:`MPI_Dist_graph_create` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst index b3e7533f2b8..58c7c76c573 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoall.3.rst @@ -116,7 +116,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -130,7 +130,7 @@ layout are determined by the topology of *comm*. Example of :ref:`MPI_Neighbor_alltoall` semantics for cartesian topologies: -:: +.. code-block:: c MPI_Cart_get(comm, maxdims, dims, periods, coords); for (dim = 0, i = 0 ; dim < dims ; ++dim) { @@ -178,11 +178,11 @@ sources and destinations in the communication routines are 2*ndims with ndims defined in :ref:`MPI_Cart_create`. If a neighbor does not exist, i.e., at the border of a Cartesian topology in the case of a non-periodic virtual grid dimension (i.e., periods[...]==false), then this neighbor is -defined to be MPI_PROC_NULL. +defined to be ``MPI_PROC_NULL``. -If a neighbor in any of the functions is MPI_PROC_NULL, then the +If a neighbor in any of the functions is ``MPI_PROC_NULL``, then the neighborhood collective communication behaves like a point-to-point -communication with MPI_PROC_NULL in this direction. That is, the buffer +communication with ``MPI_PROC_NULL`` in this direction. That is, the buffer is still part of the sequence of neighbors but it is neither communicated nor updated. @@ -211,5 +211,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Neighbor_alltoallv` :ref:`MPI_Neighbor_alltoallw` :ref:`MPI_Cart_create` - :ref:`MPI_Graph_create` :ref:`MPI_Dist_graph_create` :ref:`MPI_Dist_graph_create_adjacent` + * :ref:`MPI_Neighbor_alltoallv` + * :ref:`MPI_Neighbor_alltoallw` + * :ref:`MPI_Cart_create` + * :ref:`MPI_Graph_create` + * :ref:`MPI_Dist_graph_create` + * :ref:`MPI_Dist_graph_create_adjacent` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst index 8ad37899f9b..835718a98e6 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallv.3.rst @@ -131,7 +131,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status. +* ``ierror``: Fortran only: Error status. DESCRIPTION ----------- @@ -146,7 +146,7 @@ topology of communicator *comm*) independent point-to-point communications. The neighbors and buffer layout are determined by the topology of *comm*. -:: +.. code-block:: c MPI_Cart_get(comm, maxdims, dims, periods, coords); for (dim = 0, i = 0 ; dim < dims ; ++dim) { @@ -195,11 +195,11 @@ sources and destinations in the communication routines are 2*ndims with ndims defined in :ref:`MPI_Cart_create`. If a neighbor does not exist, i.e., at the border of a Cartesian topology in the case of a non-periodic virtual grid dimension (i.e., periods[...]==false), then this neighbor is -defined to be MPI_PROC_NULL. +defined to be ``MPI_PROC_NULL``. -If a neighbor in any of the functions is MPI_PROC_NULL, then the +If a neighbor in any of the functions is ``MPI_PROC_NULL``, then the neighborhood collective communication behaves like a point-to-point -communication with MPI_PROC_NULL in this direction. That is, the buffer +communication with ``MPI_PROC_NULL`` in this direction. That is, the buffer is still part of the sequence of neighbors but it is neither communicated nor updated. @@ -227,5 +227,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Neighbor_alltoall` :ref:`MPI_Neighbor_alltoallw` :ref:`MPI_Cart_create` - :ref:`MPI_Graph_create` :ref:`MPI_Dist_graph_create` + * :ref:`MPI_Neighbor_alltoall` + * :ref:`MPI_Neighbor_alltoallw` + * :ref:`MPI_Cart_create` + * :ref:`MPI_Graph_create` + * :ref:`MPI_Dist_graph_create` diff --git a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst index 72d87a53214..01f9d8ee667 100644 --- a/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst +++ b/docs/man-openmpi/man3/MPI_Neighbor_alltoallw.3.rst @@ -136,7 +136,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer. * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status. +* ``ierror``: Fortran only: Error status. DESCRIPTION ----------- @@ -151,7 +151,7 @@ topology of communicator *comm*) independent point-to-point communications. The neighbors and buffer layout are determined by the topology of *comm*. -:: +.. code-block:: c MPI_Cart_get(comm, maxdims, dims, periods, coords); for (dim = 0, i = 0 ; dim < dims ; ++dim) { @@ -170,13 +170,13 @@ topology of *comm*. MPI_Wait_all (...); - MPI_Comm_size(comm, &n); - for (i = 0, i < n; i++) - MPI_Send(sendbuf + sdispls[i], sendcounts[i], - sendtypes[i], i, ..., comm); - for (i = 0, i < n; i++) - MPI_Recv(recvbuf + rdispls[i], recvcounts[i], - recvtypes[i], i, ..., comm); + MPI_Comm_size(comm, &n); + for (i = 0, i < n; i++) + MPI_Send(sendbuf + sdispls[i], sendcounts[i], + sendtypes[i], i, ..., comm); + for (i = 0, i < n; i++) + MPI_Recv(recvbuf + rdispls[i], recvcounts[i], + recvtypes[i], i, ..., comm); Process j sends the k-th block of its local *sendbuf* to neighbor k, which places the data in the j-th block of its local *recvbuf*. @@ -214,5 +214,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Neighbor_alltoall` :ref:`MPI_Neighbor_alltoallv` :ref:`MPI_Cart_create` - :ref:`MPI_Graph_create` :ref:`MPI_Dist_graph_create` + * :ref:`MPI_Neighbor_alltoall` + * :ref:`MPI_Neighbor_alltoallv` + * :ref:`MPI_Cart_create` + * :ref:`MPI_Graph_create` + * :ref:`MPI_Dist_graph_create` diff --git a/docs/man-openmpi/man3/MPI_Op_commutative.3.rst b/docs/man-openmpi/man3/MPI_Op_commutative.3.rst index b5b4be60bc1..d56dd43185c 100644 --- a/docs/man-openmpi/man3/MPI_Op_commutative.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_commutative.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``commute``: True if op is commutative, false otherwise (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -68,4 +68,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Op_create` + * :ref:`MPI_Op_create` diff --git a/docs/man-openmpi/man3/MPI_Op_create.3.rst b/docs/man-openmpi/man3/MPI_Op_create.3.rst index 299a5e39b27..4f1467a9f7a 100644 --- a/docs/man-openmpi/man3/MPI_Op_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_create.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``op``: Operation (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -217,4 +217,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Reduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Allreduce` :ref:`MPI_Scan` :ref:`MPI_Op_free` + * :ref:`MPI_Reduce` + * :ref:`MPI_Reduce_scatter` + * :ref:`MPI_Allreduce` + * :ref:`MPI_Scan` + * :ref:`MPI_Op_free` diff --git a/docs/man-openmpi/man3/MPI_Op_free.3.rst b/docs/man-openmpi/man3/MPI_Op_free.3.rst index 1ec6a2999c5..454507a527b 100644 --- a/docs/man-openmpi/man3/MPI_Op_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Op_free.3.rst @@ -51,7 +51,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -66,4 +66,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Op_create` :ref:`MPI_Reduce` :ref:`MPI_Allreduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Scan` + * :ref:`MPI_Op_create` + * :ref:`MPI_Reduce` + * :ref:`MPI_Allreduce` + * :ref:`MPI_Reduce_scatter` + * :ref:`MPI_Scan` diff --git a/docs/man-openmpi/man3/MPI_Open_port.3.rst b/docs/man-openmpi/man3/MPI_Open_port.3.rst index fbcd32b61de..b4c03998f87 100644 --- a/docs/man-openmpi/man3/MPI_Open_port.3.rst +++ b/docs/man-openmpi/man3/MPI_Open_port.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``port_name``: Newly established port (string). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -82,4 +82,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Comm_accept` :ref:`MPI_Comm_connect` + * :ref:`MPI_Comm_accept` + * :ref:`MPI_Comm_connect` diff --git a/docs/man-openmpi/man3/MPI_Pack.3.rst b/docs/man-openmpi/man3/MPI_Pack.3.rst index 748d289f57b..6ab5c44b73a 100644 --- a/docs/man-openmpi/man3/MPI_Pack.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack.3.rst @@ -68,7 +68,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``outbuf``: Output buffer start (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -90,27 +90,24 @@ subsequently used for sending the packed message. **Example:** An example using :ref:`MPI_Pack`: -:: - - int position, i, j, a[2]; - char buff[1000]; - - .... +.. code-block:: c - MPI_Comm_rank(MPI_COMM_WORLD, &myrank); - if (myrank == 0) - { - / * SENDER CODE */ + int myrank, position, i, j, a[2]; + char buff[1000]; - position = 0; - MPI_Pack(&i, 1, MPI_INT, buff, 1000, &position, MPI_COMM_WORLD); - MPI_Pack(&j, 1, MPI_INT, buff, 1000, &position, MPI_COMM_WORLD); - MPI_Send( buff, position, MPI_PACKED, 1, 0, MPI_COMM_WORLD); - } - else /* RECEIVER CODE */ - MPI_Recv( a, 2, MPI_INT, 0, 0, MPI_COMM_WORLD) + // ... - } + MPI_Comm_rank(MPI_COMM_WORLD, &myrank); + if (myrank == 0) { + /* SENDER CODE */ + position = 0; + MPI_Pack(&i, 1, MPI_INT, buff, 1000, &position, MPI_COMM_WORLD); + MPI_Pack(&j, 1, MPI_INT, buff, 1000, &position, MPI_COMM_WORLD); + MPI_Send(buff, position, MPI_PACKED, 1, 0, MPI_COMM_WORLD); + } else { + /* RECEIVER CODE */ + MPI_Recv(a, 2, MPI_INT, 0, 0, MPI_COMM_WORLD); + } ERRORS @@ -119,4 +116,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Unpack` :ref:`MPI_Pack_size` + * :ref:`MPI_Unpack` + * :ref:`MPI_Pack_size` diff --git a/docs/man-openmpi/man3/MPI_Pack_external.3.rst b/docs/man-openmpi/man3/MPI_Pack_external.3.rst index 813a1baef99..afd2d185bcc 100644 --- a/docs/man-openmpi/man3/MPI_Pack_external.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_external.3.rst @@ -75,7 +75,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``outbuf``: Output buffer start (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -98,7 +98,7 @@ input to a subsequent call to :ref:`MPI_Pack_external`. **Example:** An example using :ref:`MPI_Pack_external`: -:: +.. code-block:: c int position, i; double msg[5]; @@ -179,4 +179,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack_external_size` :ref:`MPI_Send` :ref:`MPI_Unpack_external` sscanf(3C) + * :ref:`MPI_Pack_external_size` + * :ref:`MPI_Send` + * :ref:`MPI_Unpack_external` + * sscanf(3C) 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 4aca72a9726..66e34f4765c 100644 --- a/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_external_size.3.rst @@ -62,7 +62,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``size``: Upper bound on size of packed message, in bytes (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -93,4 +93,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack_external` :ref:`MPI_Unpack_external` + * :ref:`MPI_Pack_external` + * :ref:`MPI_Unpack_external` diff --git a/docs/man-openmpi/man3/MPI_Pack_size.3.rst b/docs/man-openmpi/man3/MPI_Pack_size.3.rst index 94d091a8ed6..66baa466d36 100644 --- a/docs/man-openmpi/man3/MPI_Pack_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Pack_size.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``size``: Upper bound on size of packed message, in bytes (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -82,4 +82,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack` :ref:`MPI_Unpack` + * :ref:`MPI_Pack` + * :ref:`MPI_Unpack` diff --git a/docs/man-openmpi/man3/MPI_Parrived.3.rst b/docs/man-openmpi/man3/MPI_Parrived.3.rst index acf83ce95f4..98873ff97f0 100644 --- a/docs/man-openmpi/man3/MPI_Parrived.3.rst +++ b/docs/man-openmpi/man3/MPI_Parrived.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``flag``: True if partition is completed. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ @@ -64,4 +64,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pready_list` :ref:`MPI_Pready_range` :ref:`MPI_Parrived` + * :ref:`MPI_Pready_list` + * :ref:`MPI_Pready_range` + * :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Pready.3.rst b/docs/man-openmpi/man3/MPI_Pready.3.rst index 4c31824cc1c..8bc64601726 100644 --- a/docs/man-openmpi/man3/MPI_Pready.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ @@ -62,4 +62,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pready_list` :ref:`MPI_Pready_range` :ref:`MPI_Parrived` + * :ref:`MPI_Pready_list` + * :ref:`MPI_Pready_range` + * :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Pready_list.3.rst b/docs/man-openmpi/man3/MPI_Pready_list.3.rst index 32ccf5ff6bf..38ed8614fd4 100644 --- a/docs/man-openmpi/man3/MPI_Pready_list.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready_list.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ @@ -64,4 +64,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pready` :ref:`MPI_Pready_range` :ref:`MPI_Parrived` + * :ref:`MPI_Pready` + * :ref:`MPI_Pready_range` + * :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Pready_range.3.rst b/docs/man-openmpi/man3/MPI_Pready_range.3.rst index bd9438063bb..4e617168926 100644 --- a/docs/man-openmpi/man3/MPI_Pready_range.3.rst +++ b/docs/man-openmpi/man3/MPI_Pready_range.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ @@ -63,4 +63,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pready` :ref:`MPI_Pready_list` :ref:`MPI_Parrived` + * :ref:`MPI_Pready` + * :ref:`MPI_Pready_list` + * :ref:`MPI_Parrived` diff --git a/docs/man-openmpi/man3/MPI_Precv_init.3.rst b/docs/man-openmpi/man3/MPI_Precv_init.3.rst index 7fa3642407a..b3b17487abd 100644 --- a/docs/man-openmpi/man3/MPI_Precv_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Precv_init.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ @@ -82,4 +82,4 @@ corrected in future versions. .. seealso:: - :ref:`MPI_Psend_init` + * :ref:`MPI_Psend_init` diff --git a/docs/man-openmpi/man3/MPI_Probe.3.rst b/docs/man-openmpi/man3/MPI_Probe.3.rst index 844dedf9d5d..92b8e99d138 100644 --- a/docs/man-openmpi/man3/MPI_Probe.3.rst +++ b/docs/man-openmpi/man3/MPI_Probe.3.rst @@ -49,14 +49,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -* ``source``: Source rank or MPI_ANY_SOURCE (integer). -* ``tag``: Tag value or MPI_ANY_TAG (integer). +* ``source``: Source rank or ``MPI_ANY_SOURCE`` (integer). +* ``tag``: Tag value or ``MPI_ANY_TAG`` (integer). * ``comm``: Communicator (handle). OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -71,7 +71,7 @@ receive buffer, according to the length of the probed message. returns only after a matching message has been found. 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. The semantics of :ref:`MPI_Probe` and :ref:`MPI_Iprobe` guarantee progress: If a call @@ -86,52 +86,52 @@ concurrent receive operation. **Example 1:** Use blocking probe to wait for an incoming message. -:: +.. code-block:: fortran CALL MPI_COMM_RANK(comm, rank, ierr) - IF (rank.EQ.0) THEN - CALL MPI_SEND(i, 1, MPI_INTEGER, 2, 0, comm, ierr) - ELSE IF(rank.EQ.1) THEN - CALL MPI_SEND(x, 1, MPI_REAL, 2, 0, comm, ierr) - ELSE ! rank.EQ.2 - DO i=1, 2 - CALL MPI_PROBE(MPI_ANY_SOURCE, 0, - comm, status, ierr) - IF (status(MPI_SOURCE) = 0) THEN - 100 CALL MPI_RECV(i, 1, MPI_INTEGER, 0, 0, status, ierr) - ELSE - 200 CALL MPI_RECV(x, 1, MPI_REAL, 1, 0, status, ierr) - END IF - END DO - END IF + IF (rank == 0) THEN + CALL MPI_SEND(i, 1, MPI_INTEGER, 2, 0, comm, ierr) + ELSE IF(rank == 1) THEN + CALL MPI_SEND(x, 1, MPI_REAL, 2, 0, comm, ierr) + ELSE ! rank == 2 + DO i=1, 2 + CALL MPI_PROBE(MPI_ANY_SOURCE, 0, + comm, status, ierr) + IF (status(MPI_SOURCE) = 0) THEN + CALL MPI_RECV(i, 1, MPI_INTEGER, 0, 0, status, ierr) + ELSE + CALL MPI_RECV(x, 1, MPI_REAL, 1, 0, status, ierr) + END IF + END DO + END IF Each message is received with the right type. **Example 2:** A program similar to the previous example, but with a problem. -:: +.. code-block:: fortran CALL MPI_COMM_RANK(comm, rank, ierr) - IF (rank.EQ.0) THEN - CALL MPI_SEND(i, 1, MPI_INTEGER, 2, 0, comm, ierr) - ELSE IF(rank.EQ.1) THEN - CALL MPI_SEND(x, 1, MPI_REAL, 2, 0, comm, ierr) - ELSE - DO i=1, 2 - CALL MPI_PROBE(MPI_ANY_SOURCE, 0, - comm, status, ierr) - IF (status(MPI_SOURCE) = 0) THEN - 100 CALL MPI_RECV(i, 1, MPI_INTEGER, MPI_ANY_SOURCE, - 0, status, ierr) - ELSE - 200 CALL MPI_RECV(x, 1, MPI_REAL, MPI_ANY_SOURCE, - 0, status, ierr) - END IF - END DO - END IF - -We slightly modified Example 2, using MPI_ANY_SOURCE as the source + IF (rank == 0) THEN + CALL MPI_SEND(i, 1, MPI_INTEGER, 2, 0, comm, ierr) + ELSE IF(rank.EQ.1) THEN + CALL MPI_SEND(x, 1, MPI_REAL, 2, 0, comm, ierr) + ELSE + DO i=1, 2 + CALL MPI_PROBE(MPI_ANY_SOURCE, 0, + comm, status, ierr) + IF (status(MPI_SOURCE) = 0) THEN + CALL MPI_RECV(i, 1, MPI_INTEGER, MPI_ANY_SOURCE, + 0, status, ierr) + ELSE + CALL MPI_RECV(x, 1, MPI_REAL, MPI_ANY_SOURCE, + 0, status, ierr) + END IF + END DO + END IF + +We slightly modified Example 2, using ``MPI_ANY_SOURCE`` as the source argument in the two receive calls in statements labeled 100 and 200. The program is now incorrect: The receive operation may receive a message that is distinct from the message probed by the preceding call to @@ -144,4 +144,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Iprobe` :ref:`MPI_Cancel` + * :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 298a93da7c2..686be34fda6 100644 --- a/docs/man-openmpi/man3/MPI_Psend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Psend_init.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ @@ -82,4 +82,4 @@ corrected in future versions. .. seealso:: - :ref:`MPI_Precv_init` + * :ref:`MPI_Precv_init` diff --git a/docs/man-openmpi/man3/MPI_Publish_name.3.rst b/docs/man-openmpi/man3/MPI_Publish_name.3.rst index 4fb9f77cb00..ef1a87c33b2 100644 --- a/docs/man-openmpi/man3/MPI_Publish_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Publish_name.3.rst @@ -6,9 +6,7 @@ MPI_Publish_name .. include_body -:: - - MPI_Publish_name - Publishes a service name associated with a port +:ref:`MPI_Publish_name` - Publishes a service name associated with a port SYNTAX @@ -58,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -157,4 +155,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Lookup_name` :ref:`MPI_Open_port` + * :ref:`MPI_Lookup_name` + * :ref:`MPI_Open_port` diff --git a/docs/man-openmpi/man3/MPI_Put.3.rst b/docs/man-openmpi/man3/MPI_Put.3.rst index 271f3b099d8..9e0288f0531 100644 --- a/docs/man-openmpi/man3/MPI_Put.3.rst +++ b/docs/man-openmpi/man3/MPI_Put.3.rst @@ -94,7 +94,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- * ``request``: MPI_Rput: RMA request -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -170,11 +170,11 @@ The MPI standard prescribes portable Fortran syntax for the *TARGET_DISP* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND TARGET_DISP -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -184,5 +184,10 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Get` :ref:`MPI_Rget` :ref:`MPI_Accumulate` :ref:`MPI_Win_flush` :ref:`MPI_Win_flush_all` - :ref:`MPI_Win_unlock` :ref:`MPI_Win_unlock_all` + * :ref:`MPI_Get` + * :ref:`MPI_Rget` + * :ref:`MPI_Accumulate` + * :ref:`MPI_Win_flush` + * :ref:`MPI_Win_flush_all` + * :ref:`MPI_Win_unlock` + * :ref:`MPI_Win_unlock_all` diff --git a/docs/man-openmpi/man3/MPI_Query_thread.3.rst b/docs/man-openmpi/man3/MPI_Query_thread.3.rst index 5a1b18d2a29..4f472d45170 100644 --- a/docs/man-openmpi/man3/MPI_Query_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_Query_thread.3.rst @@ -48,7 +48,7 @@ Fortran 2008 Syntax OUTPUT PARAMETERS ----------------- * ``provided``: C/Fortran only: Level of thread support (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -89,4 +89,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Init` :ref:`MPI_Init_thread` + * :ref:`MPI_Init` + * :ref:`MPI_Init_thread` diff --git a/docs/man-openmpi/man3/MPI_Recv.3.rst b/docs/man-openmpi/man3/MPI_Recv.3.rst index 382c7d993a2..76f84c5aec7 100644 --- a/docs/man-openmpi/man3/MPI_Recv.3.rst +++ b/docs/man-openmpi/man3/MPI_Recv.3.rst @@ -64,7 +64,7 @@ OUTPUT PARAMETERS ----------------- * ``buf``: Initial address of receive buffer (choice). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -109,18 +109,18 @@ to the receiving process, and if its source, tag, and communicator (comm) values match the source, tag, and comm values specified by the receive operation. The receive operation may specify a wildcard value for source and/or tag, indicating that any source and/or tag are -acceptable. The wildcard value for source is source = MPI_ANY_SOURCE. -The wildcard value for tag is tag = MPI_ANY_TAG. There is no wildcard +acceptable. The wildcard value for source is source = ``MPI_ANY_SOURCE``. +The wildcard value for tag is tag = ``MPI_ANY_TAG``. There is no wildcard value for comm. The scope of these wildcards is limited to the processes in the group of the specified communicator. The message tag is specified by the tag argument of the receive operation. -The argument source, if different from MPI_ANY_SOURCE, is specified as a +The argument source, if different from ``MPI_ANY_SOURCE``, is specified as a rank within the process group associated with that same communicator (remote process group, for intercommunicators). Thus, the range of valid -values for the source argument is {0,...,n-1} {MPI_ANY_SOURCE}, where n +values for the source argument is {0,...,n-1} {``MPI_ANY_SOURCE``}, where n is the number of processes in this group. Note the asymmetry between send and receive operations: A receive @@ -137,7 +137,7 @@ above, since this may lead to deadlock. See Section 3.5 of the MPI-1 Standard, "Semantics of Point-to-Point Communication." 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. @@ -147,4 +147,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Irecv` :ref:`MPI_Probe` + * :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 ac423a8a152..45c72fc9056 100644 --- a/docs/man-openmpi/man3/MPI_Recv_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Recv_init.3.rst @@ -67,7 +67,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -89,5 +89,10 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Bsend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Send_init` MPI_Sssend_init :ref:`MPI_Start` - :ref:`MPI_Startall` :ref:`MPI_Request_free` + * :ref:`MPI_Bsend_init` + * :ref:`MPI_Rsend_init` + * :ref:`MPI_Send_init` + * MPI_Sssend_init + * :ref:`MPI_Start` + * :ref:`MPI_Startall` + * :ref:`MPI_Request_free` diff --git a/docs/man-openmpi/man3/MPI_Reduce.3.rst b/docs/man-openmpi/man3/MPI_Reduce.3.rst index f049398b571..5fcb8114f48 100644 --- a/docs/man-openmpi/man3/MPI_Reduce.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce.3.rst @@ -112,7 +112,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice, significant only at root). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -169,7 +169,7 @@ When the communicator is an inter-communicator, the root process in the first group combines data from all the processes in the second group and then performs the *op* operation. The first group defines the root process. That process uses MPI_ROOT as the value of its *root* argument. -The remaining processes use MPI_PROC_NULL as the value of their *root* +The remaining processes use ``MPI_PROC_NULL`` as the value of their *root* argument. All processes in the second group use the rank of that root process in the first group as the value of their *root* argument. Only the send buffer arguments are significant in the second group, and only @@ -266,7 +266,7 @@ Now, the valid datatypes for each option is specified below. that are distributed across a group of processes and returns the answer at process zero. -:: +.. code-block:: fortran SUBROUTINE PAR_BLAS1(m, a, b, c, comm) REAL a(m), b(m) ! local slice of array @@ -288,7 +288,7 @@ at process zero. array that are distributed across a group of processes and returns the answer at process zero. -:: +.. code-block:: fortran SUBROUTINE PAR_BLAS2(m, n, a, b, c, comm) REAL a(m), b(m,n) ! local slice of array @@ -322,7 +322,7 @@ value. The operation that defines MPI_MAXLOC is -.. code-block:: c +:: ( u ) ( v ) ( w ) ( ) o ( ) = ( ) @@ -341,8 +341,10 @@ The operation that defines MPI_MAXLOC is ( j if u < v) - MPI_MINLOC is defined similarly: +MPI_MINLOC is defined similarly: +:: + ( u ) ( v ) ( w ) ( ) o ( ) = ( ) ( i ) ( j ) ( k ) @@ -404,7 +406,7 @@ datatypes: The data type MPI_2REAL is equivalent to: -:: +.. code-block:: fortran MPI_TYPE_CONTIGUOUS(2, MPI_REAL, MPI_2REAL) @@ -414,7 +416,7 @@ MPI_2INT. The datatype MPI_FLOAT_INT is as if defined by the following sequence of instructions. -:: +.. code-block:: c type[0] = MPI_FLOAT type[1] = MPI_INT @@ -430,7 +432,7 @@ Similar statements apply for MPI_LONG_INT and MPI_DOUBLE_INT. of the 30 locations, compute the value and rank of the process containing the largest value. -:: +.. code-block:: c ... /* each process has an array of 30 double: ain[30] @@ -494,7 +496,7 @@ containing the largest value. minimum global value, the rank of the process that holds it, and its index on this process. -:: +.. code-block:: c #define LEN 1000 @@ -553,4 +555,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Allreduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Scan` :ref:`MPI_Op_create` :ref:`MPI_Op_free` + * :ref:`MPI_Allreduce` + * :ref:`MPI_Reduce_scatter` + * :ref:`MPI_Scan` + * :ref:`MPI_Op_create` + * :ref:`MPI_Op_free` diff --git a/docs/man-openmpi/man3/MPI_Reduce_local.3.rst b/docs/man-openmpi/man3/MPI_Reduce_local.3.rst index c3f9a28ed8b..54638bbc254 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_local.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_local.3.rst @@ -61,7 +61,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``inoutbuf``: Address of in/out buffer (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -152,7 +152,7 @@ below (MINLOC and MAXLOC). For the other predefined operations, we enumerate below the allowed combinations of op and datatype arguments. First, define groups of MPI basic datatypes in the following way: -.. code-block:: c +:: C integer: MPI_INT, MPI_LONG, MPI_SHORT, MPI_UNSIGNED_SHORT, MPI_UNSIGNED, @@ -194,7 +194,7 @@ value. The operation that defines MPI_MAXLOC is -.. code-block:: c +:: ( u ) ( v ) ( w ) ( ) o ( ) = ( ) @@ -213,8 +213,10 @@ The operation that defines MPI_MAXLOC is ( j if u < v) - MPI_MINLOC is defined similarly: +MPI_MINLOC is defined similarly: +:: + ( u ) ( v ) ( w ) ( ) o ( ) = ( ) ( i ) ( j ) ( k ) @@ -276,7 +278,7 @@ datatypes: The data type MPI_2REAL is equivalent to: -:: +.. code-block:: fortran MPI_TYPE_CONTIGUOUS(2, MPI_REAL, MPI_2REAL) @@ -286,7 +288,7 @@ MPI_2INT. The datatype MPI_FLOAT_INT is as if defined by the following sequence of instructions. -:: +::.. code-block:: c type[0] = MPI_FLOAT type[1] = MPI_INT @@ -321,5 +323,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Allreduce` :ref:`MPI_Reduce` :ref:`MPI_Reduce_scatter` :ref:`MPI_Scan` :ref:`MPI_Op_create` - :ref:`MPI_Op_free` + * :ref:`MPI_Allreduce` + * :ref:`MPI_Reduce` + * :ref:`MPI_Reduce_scatter` + * :ref:`MPI_Scan` + * :ref:`MPI_Op_create` + * :ref:`MPI_Op_free` diff --git a/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst b/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst index b33b0db933b..a4fe9510c2c 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter.3.rst @@ -27,9 +27,9 @@ C Syntax int MPI_Ireduce_scatter(const void *sendbuf, void *recvbuf, const int recvcounts[], MPI_Datatype datatype, MPI_Op op, MPI_Comm comm, MPI_Request *request) -int MPI_Reduce_scatter_init(const void \*\ *sendbuf*, void\ *\*recvbuf*, -const int\ *recvcounts*\ [], MPI_Datatype\ *datatype*, MPI_Op\ *op*, -MPI_Comm\ *comm*, MPI_Info *info*, MPI_Request *\*request*) + int MPI_Reduce_scatter_init(const void *sendbuf, void *recvbuf, + const int recvcounts[], MPI_Datatype datatype, MPI_Op op, + MPI_Comm comm, MPI_Info info, MPI_Request *request) Fortran Syntax @@ -108,7 +108,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 6157c54b29b..07e425843c4 100644 --- a/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst +++ b/docs/man-openmpi/man3/MPI_Reduce_scatter_block.3.rst @@ -110,13 +110,13 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Starting address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- :ref:`MPI_Reduce_scatter_block` first does an element-wise reduction on vector -of *count* = n \* *recvcount* elements in the send buffer defined by +of ``count = n * recvcount`` elements in the send buffer defined by *sendbuf*, *count*, and *datatype*, using the operation *op*, where n is the number of processes in the group of *comm*. Next, the resulting vector of results is split into n disjoint segments, where n is the @@ -169,4 +169,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Reduce_scatter` + * :ref:`MPI_Reduce_scatter` diff --git a/docs/man-openmpi/man3/MPI_Register_datarep.3.rst b/docs/man-openmpi/man3/MPI_Register_datarep.3.rst index 52fdfee1cd3..1cde254d7ac 100644 --- a/docs/man-openmpi/man3/MPI_Register_datarep.3.rst +++ b/docs/man-openmpi/man3/MPI_Register_datarep.3.rst @@ -70,7 +70,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Request_free.3.rst b/docs/man-openmpi/man3/MPI_Request_free.3.rst index 28bb691f98c..26956c97f84 100644 --- a/docs/man-openmpi/man3/MPI_Request_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Request_free.3.rst @@ -82,7 +82,7 @@ receive has completed and the receive buffer can be reused. **Example:** -:: +.. code-block:: fortran CALL MPI_COMM_RANK(MPI_COMM_WORLD, rank) IF(rank.EQ.0) THEN @@ -118,10 +118,23 @@ can not use the request in a wait or test routine (e.g., :ref:`MPI_Wait` ). ERRORS ------ -.. include ../ERRORS.rst +.. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Isend` :ref:`MPI_Irecv` :ref:`MPI_Issend` :ref:`MPI_Ibsend` :ref:`MPI_Irsend` :ref:`MPI_Recv_init` - :ref:`MPI_Send_init` :ref:`MPI_Ssend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Test` :ref:`MPI_Wait` - :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` :ref:`MPI_Testall` :ref:`MPI_Testany` - :ref:`MPI_Testsome` + * :ref:`MPI_Isend` + * :ref:`MPI_Irecv` + * :ref:`MPI_Issend` + * :ref:`MPI_Ibsend` + * :ref:`MPI_Irsend` + * :ref:`MPI_Recv_init` + * :ref:`MPI_Send_init` + * :ref:`MPI_Ssend_init` + * :ref:`MPI_Rsend_init` + * :ref:`MPI_Test` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` 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 039f70b6a9e..cdd456310cb 100644 --- a/docs/man-openmpi/man3/MPI_Request_get_status.3.rst +++ b/docs/man-openmpi/man3/MPI_Request_get_status.3.rst @@ -55,20 +55,20 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- -* ``flag``: Boolean flag, same as from MPI_Test (logical). -* ``status``: MPI_Status object if flag is true (status). +* ``flag``: Boolean flag, same as from :ref:`MPI_Test` (logical). +* ``status``: ``MPI_Status`` object if flag is true (status). DESCRIPTION ----------- -:ref:`MPI_Request_get_status` sets *flag*\ =\ *true* if the operation is -complete or sets *flag*\ =\ *false* if it is not complete. If the +:ref:`MPI_Request_get_status` sets ``flag = true`` if the operation is +complete or sets ``flag = false`` if it is not complete. If the operation is complete, it returns in *status* the request status. It does not deallocate or deactivate the request; a subsequent call to test, wait, or free should be executed with that request. 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. diff --git a/docs/man-openmpi/man3/MPI_Rsend.3.rst b/docs/man-openmpi/man3/MPI_Rsend.3.rst index 84ea615c5ab..92a5f95be93 100644 --- a/docs/man-openmpi/man3/MPI_Rsend.3.rst +++ b/docs/man-openmpi/man3/MPI_Rsend.3.rst @@ -61,7 +61,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Rsend_init.3.rst b/docs/man-openmpi/man3/MPI_Rsend_init.3.rst index fb5c94bb9d3..1ec661a7031 100644 --- a/docs/man-openmpi/man3/MPI_Rsend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Rsend_init.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -82,5 +82,10 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Bsend_init` :ref:`MPI_Send_init` MPI_Sssend_init :ref:`MPI_Recv_init` :ref:`MPI_Start` - :ref:`MPI_Startall` :ref:`MPI_Request_free` + * :ref:`MPI_Bsend_init` + * :ref:`MPI_Send_init` + * MPI_Sssend_init + * :ref:`MPI_Recv_init` + * :ref:`MPI_Start` + * :ref:`MPI_Startall` + * :ref:`MPI_Request_free` diff --git a/docs/man-openmpi/man3/MPI_Scan.3.rst b/docs/man-openmpi/man3/MPI_Scan.3.rst index 49dd8f31fbb..47554ee8b8c 100644 --- a/docs/man-openmpi/man3/MPI_Scan.3.rst +++ b/docs/man-openmpi/man3/MPI_Scan.3.rst @@ -103,7 +103,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -141,14 +141,14 @@ logical(j). The operator that produces this effect is [ ] o [ ] = [ ] [ i ] [ j ] [ j ] -where + where -( u + v if i = j w = ( ( v if i != j + ( u + v if i = j w = ( ( v if i != j Note that this is a noncommutative operator. C code that implements it is given below. -:: +.. code-block:: c typedef struct { double val; @@ -182,7 +182,7 @@ the right-hand operand of the operator. When using this operator, we must be careful to specify that it is noncommutative, as in the following: -:: +.. code-block:: c int i, base; SeqScanPair a, answer; @@ -241,4 +241,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Exscan` :ref:`MPI_Op_create` :ref:`MPI_Reduce` + * :ref:`MPI_Exscan` + * :ref:`MPI_Op_create` + * :ref:`MPI_Reduce` diff --git a/docs/man-openmpi/man3/MPI_Scatter.3.rst b/docs/man-openmpi/man3/MPI_Scatter.3.rst index cda14d6166e..9a78a045c36 100644 --- a/docs/man-openmpi/man3/MPI_Scatter.3.rst +++ b/docs/man-openmpi/man3/MPI_Scatter.3.rst @@ -112,7 +112,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -121,19 +121,19 @@ DESCRIPTION The outcome is as if the root executed n send operations, -:: +.. code-block:: c MPI_Send(sendbuf + i * sendcount * extent(sendtype), sendcount, - sendtype, i, ...) + sendtype, i, ...); and each process executed a receive, -:: +.. code-block:: c - MPI_Recv(recvbuf, recvcount, recvtype, i, ...). + MPI_Recv(recvbuf, recvcount, recvtype, i, ...).; An alternative description is that the root sends a message with -MPI_Send(sendbuf, *sendcount* \* *n*, *sendtype*, ...). This message +``MPI_Send(sendbuf, sendcount * n, sendtype, ...)``. This message is split into *n* equal segments, the ith segment is sent to the ith process in the group, and each process receives this message as above. @@ -161,7 +161,7 @@ to achieve symmetry with :ref:`MPI_Gather`, where the corresponding restriction **Example:** The reverse of Example 1 in the :ref:`MPI_Gather` manpage. Scatter sets of 100 ints from the root to each process in the group. -:: +.. code-block:: c MPI_Comm comm; int gsize,*sendbuf; @@ -197,7 +197,7 @@ WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR When the communicator is an inter-communicator, the root process in the first group sends data to all processes in the second group. The first group defines the root process. That process uses MPI_ROOT as the value -of its *root* argument. The remaining processes use MPI_PROC_NULL as the +of its *root* argument. The remaining processes use ``MPI_PROC_NULL`` as the value of their *root* argument. All processes in the second group use the rank of that root process in the first group as the value of their *root* argument. The receive buffer argument of the root process in the @@ -211,4 +211,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Scatterv` :ref:`MPI_Gather` :ref:`MPI_Gatherv` + * :ref:`MPI_Scatterv` + * :ref:`MPI_Gather` + * :ref:`MPI_Gatherv` diff --git a/docs/man-openmpi/man3/MPI_Scatterv.3.rst b/docs/man-openmpi/man3/MPI_Scatterv.3.rst index cee4ca49ae3..332df42e604 100644 --- a/docs/man-openmpi/man3/MPI_Scatterv.3.rst +++ b/docs/man-openmpi/man3/MPI_Scatterv.3.rst @@ -115,7 +115,7 @@ OUTPUT PARAMETERS ----------------- * ``recvbuf``: Address of receive buffer (choice). * ``request``: Request (handle, non-blocking only). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -129,16 +129,16 @@ taken from on the root, by providing the new argument, *displs*. The outcome is as if the root executed *n* send operations, -:: +.. code-block:: c - MPI_Send(sendbuf + displs[i] * extent(sendtype), \ - sendcounts[i], sendtype, i, ...) + MPI_Send(sendbuf + displs[i] * extent(sendtype), + sendcounts[i], sendtype, i, ...); - and each process executed a receive, + // and each process executed a receive, MPI_Recv(recvbuf, recvcount, recvtype, root, ...) - The send buffer is ignored for all nonroot processes. +The send buffer is ignored for all nonroot processes. The type signature implied by *sendcount*\ [*i*], *sendtype* at the root must be equal to the type signature implied by *recvcount*, *recvtype* @@ -162,7 +162,7 @@ a 100 x 150 C array at process *i*. .. code-block:: c - MPI_Comm comm; + MPI_Comm comm; int gsize,recvarray[100][150],*rptr; int root, *sendbuf, myrank, bufsize, *stride; MPI_Datatype rtype; @@ -198,25 +198,25 @@ root process scatters sets of 100 ints to the other processes, but the sets of 100 are stride ints apart in the sending buffer. Requires use of :ref:`MPI_Scatterv`, where *stride* >= 100. -:: +.. code-block:: c MPI_Comm comm; - int gsize,*sendbuf; - int root, rbuf[100], i, *displs, *scounts; + int gsize,*sendbuf; + int root, rbuf[100], i, *displs, *scounts; ... MPI_Comm_size(comm, &gsize); - sendbuf = (int *)malloc(gsize*stride*sizeof(int)); - ... - displs = (int *)malloc(gsize*sizeof(int)); - scounts = (int *)malloc(gsize*sizeof(int)); - for (i=0; i @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: Fortran +.. code-block:: Fortran USE mpi_f08 @@ -46,13 +46,13 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- session : session with error handler (handle). -- errorcode : error code (integer). +* ``session`` : session with error handler (handle). +* ``errorcode`` : error code (integer). OUTPUT PARAMETERS ----------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 d50e2f32aba..5bac8378a6d 100644 --- a/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_create_errhandler.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -36,7 +36,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,13 +48,13 @@ Fortran 2008 Syntax INPUT PARAMETER --------------- -- ``function`` : User-defined error handling procedure (function). +* ``function`` : User-defined error handling procedure (function). OUTPUT PARAMETERS ----------------- -- ``errhandler`` : MPI error handler (handle). -- ``IERROR`` : Fortran only: Error status (integer). +* ``errhandler`` : MPI error handler (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- @@ -63,9 +63,9 @@ DESCRIPTION attached to sessions. This ``function`` is identical to :ref:`MPI_Errhandler_create`, the use of which is deprecated. In C, the user routine should be a ``function`` of type -MPI_Session_errhandler_function, which is defined as +``MPI_Session_errhandler_function``, which is defined as -.. code:: c +.. code-block:: c typedef void MPI_Session_errhandler_function(MPI_Session *, int *, ...); @@ -74,7 +74,7 @@ to be returned by the MPI routine that raised the error. This typedef replaces ``MPI_Handler_function``, the use of which is deprecated. In Fortran, the user routine should be of this form: -.. code:: fortran +.. code-block:: fortran SUBROUTINE SESSION_ERRHANDLER_FUNCTION(SESSION, ERROR_CODE, ...) INTEGER SESSION, ERROR_CODE diff --git a/docs/man-openmpi/man3/MPI_Session_f2c.3.rst b/docs/man-openmpi/man3/MPI_Session_f2c.3.rst index b675d830d51..940965e600e 100644 --- a/docs/man-openmpi/man3/MPI_Session_f2c.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_f2c.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,8 +24,8 @@ C Syntax PARAMETERS ---------- -- ``f_session``: ``mpi``-style ``INTEGER`` MPI session object -- ``c_session``: C-style MPI session object +* ``f_session``: ``mpi``-style ``INTEGER`` MPI session object +* ``c_session``: C-style MPI session object DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Session_finalize.3.rst b/docs/man-openmpi/man3/MPI_Session_finalize.3.rst index a3e0cd17d93..7937c079f1a 100644 --- a/docs/man-openmpi/man3/MPI_Session_finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_finalize.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -44,12 +44,12 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- session : session to be finalized (handle) +* ``session`` : session to be finalized (handle) OUTPUT PARAMETERS ----------------- -- IERROR : Fortran only: Error status (integer). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 83ec012a44e..14d2a83cb41 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_errhandler.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: New error handler for session (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 400172bd2b6..d5fe6c279c8 100644 --- a/docs/man-openmpi/man3/MPI_Session_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_get_info.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -45,13 +45,13 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- session : session (handle) +* ``session`` : session (handle) OUTPUT PARAMETERS ----------------- -- info_used: info object (handle) -- IERROR : Fortran only: Error status (integer). +* ``info_used`` : info object (handle) +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 efb0a2ea6a0..da131c4ea36 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 @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -49,20 +49,20 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- session : session (handle) -- info: info object (handle) -- n: index of the desired process set name (integer) +* ``session`` : session (handle) +* ``info`` : info object (handle) +* ``n`` : index of the desired process set name (integer) INPUT/OUTPUT PARAMETER ^^^^^^^^^^^^^^^^^^^^^^ -- pset_len: length of the pset_name argument (integer) +* ``pset_len`` : length of the pset_name argument (integer) OUTPUT PARAMETERS ----------------- -- pset_name : name of the nth process set (string) -- IERROR : Fortran only: Error status (integer). +* ``pset_name`` : name of the nth process set (string) +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 504966dde95..03ca454aa74 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 @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -34,7 +34,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -47,14 +47,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- session : session (handle) -- info: info object (handle) +* ``session`` : session (handle) +* ``info`` : info object (handle) OUTPUT PARAMETERS ----------------- -- npset_names : number of available process sets (non-negtive integer) -- IERROR : Fortran only: Error status (integer). +* ``npset_names`` : number of available process sets (non-negtive integer) +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 391de1b8d50..a92d11e737d 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 @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -23,7 +23,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -35,7 +35,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -48,14 +48,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- session : session (handle) -- pset_name : name of process set (string) +* ``session`` : session (handle) +* ``pset_name`` : name of process set (string) OUTPUT PARAMETERS ----------------- -- info: info object (handle) -- IERROR : Fortran only: Error status (integer). +* ``info`` : info object (handle) +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Session_init.3.rst b/docs/man-openmpi/man3/MPI_Session_init.3.rst index 5ab3e64e6ed..d309a0f3a6c 100644 --- a/docs/man-openmpi/man3/MPI_Session_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_init.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,7 +22,7 @@ C Syntax Fortran Syntax ^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI ! or the older form: INCLUDE 'mpif.h' @@ -33,7 +33,7 @@ Fortran Syntax Fortran 2008 Syntax ^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -46,15 +46,15 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- -- info : info object (handle) -- errhandler : error handler to be attached to the returned session +* ``info`` : info object (handle) +* ``errhandler`` : error handler to be attached to the returned session (handle) OUTPUT PARAMETERS ----------------- -- session : New session (handle). -- IERROR : Fortran only: Error status (integer). +* ``session`` : New session (handle). +* ``ierror`` : Fortran only: Error status (integer). DESCRIPTION ----------- 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 be3101c1be1..b5a158782ac 100644 --- a/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Session_set_errhandler.3.rst @@ -55,7 +55,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: New error handler for session (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Sizeof.3.rst b/docs/man-openmpi/man3/MPI_Sizeof.3.rst index 02131db0c08..27e804629de 100644 --- a/docs/man-openmpi/man3/MPI_Sizeof.3.rst +++ b/docs/man-openmpi/man3/MPI_Sizeof.3.rst @@ -44,7 +44,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``SIZE``: Size of machine representation of that type (integer). -* ``IERROR``: Error status (integer). +* ``ierror``: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Ssend.3.rst b/docs/man-openmpi/man3/MPI_Ssend.3.rst index 6fc37457506..2354d5808db 100644 --- a/docs/man-openmpi/man3/MPI_Ssend.3.rst +++ b/docs/man-openmpi/man3/MPI_Ssend.3.rst @@ -61,7 +61,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Ssend_init.3.rst b/docs/man-openmpi/man3/MPI_Ssend_init.3.rst index def77911dd9..2d214a5140c 100644 --- a/docs/man-openmpi/man3/MPI_Ssend_init.3.rst +++ b/docs/man-openmpi/man3/MPI_Ssend_init.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``request``: Communication request (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -82,5 +82,10 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Bsend_init` :ref:`MPI_Send_init` :ref:`MPI_Rsend_init` :ref:`MPI_Recv_init` :ref:`MPI_Start` - :ref:`MPI_Startall` :ref:`MPI_Ssend` + * :ref:`MPI_Bsend_init` + * :ref:`MPI_Send_init` + * :ref:`MPI_Rsend_init` + * :ref:`MPI_Recv_init` + * :ref:`MPI_Start` + * :ref:`MPI_Startall` + * :ref:`MPI_Ssend` diff --git a/docs/man-openmpi/man3/MPI_Start.3.rst b/docs/man-openmpi/man3/MPI_Start.3.rst index 66da3402594..fc943577068 100644 --- a/docs/man-openmpi/man3/MPI_Start.3.rst +++ b/docs/man-openmpi/man3/MPI_Start.3.rst @@ -52,7 +52,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -86,5 +86,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Bsend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Send_init` MPI_Sssend_init - :ref:`MPI_Recv_init` :ref:`MPI_Startall` + * :ref:`MPI_Bsend_init` + * :ref:`MPI_Rsend_init` + * :ref:`MPI_Send_init` + * MPI_Sssend_init + * :ref:`MPI_Recv_init` + * :ref:`MPI_Startall` diff --git a/docs/man-openmpi/man3/MPI_Startall.3.rst b/docs/man-openmpi/man3/MPI_Startall.3.rst index b26a70992b1..24beade39cb 100644 --- a/docs/man-openmpi/man3/MPI_Startall.3.rst +++ b/docs/man-openmpi/man3/MPI_Startall.3.rst @@ -56,7 +56,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -105,5 +105,10 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Bsend_init` :ref:`MPI_Rsend_init` :ref:`MPI_Send_init` :ref:`MPI_Ssend_init` :ref:`MPI_Recv_init` - :ref:`MPI_Start` :ref:`MPI_Request_free` + * :ref:`MPI_Bsend_init` + * :ref:`MPI_Rsend_init` + * :ref:`MPI_Send_init` + * :ref:`MPI_Ssend_init` + * :ref:`MPI_Recv_init` + * :ref:`MPI_Start` + * :ref:`MPI_Request_free` diff --git a/docs/man-openmpi/man3/MPI_Status_f082c.3.rst b/docs/man-openmpi/man3/MPI_Status_f082c.3.rst index 3dd388539a7..74b85bf29da 100644 --- a/docs/man-openmpi/man3/MPI_Status_f082c.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_f082c.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,8 +24,8 @@ C Syntax PARAMETERS ---------- -- f08_status: mpi_f08-style MPI status object -- c_status: C-style MPI status object +* ``f08_status`` : mpi_f08-style MPI status object +* ``c_status`` : C-style MPI status object DESCRIPTION ----------- @@ -36,15 +36,15 @@ is a structure), and vice versa. The conversion occurs on all the information in status, including that which is hidden. That is, no status information is lost in the conversion. -When using MPI_Status_f082c(), if f08_status is a valid Fortran status, -but not the Fortran value of MPI_F08_STATUS_IGNORE or -MPI_F08_STATUSES_IGNORE, then MPI_Status_f082c() returns in c_status a -valid C status with the same content. If f08_status is the Fortran value -of MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if f08_status is not a +When using :ref:`MPI_Status_f082c`, if ``f08_status`` is a valid Fortran status, +but not the Fortran value of ``MPI_F08_STATUS_IGNORE`` or +``MPI_F08_STATUSES_IGNORE``, then :ref:`MPI_Status_f082c` returns in ``c_status`` a +valid C status with the same content. If ``f08_status`` is the Fortran value +of ``MPI_STATUS_IGNORE`` or ``MPI_STATUSES_IGNORE``, or if ``f08_status`` is not a valid Fortran status, then the call is erroneous. -When using MPI_Status_c2f08(), the opposite conversion is applied. If -c_status is MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if c_status is +When using :ref:`MPI_Status_c2f08`, the opposite conversion is applied. If +``c_status`` is ``MPI_STATUS_IGNORE`` or ``MPI_STATUSES_IGNORE``, or if ``c_status`` is not a valid C status, then the call is erroneous. The input status has the same source, tag and error code values as the diff --git a/docs/man-openmpi/man3/MPI_Status_f082f.3.rst b/docs/man-openmpi/man3/MPI_Status_f082f.3.rst index 4eca8d21143..cac8958b152 100644 --- a/docs/man-openmpi/man3/MPI_Status_f082f.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_f082f.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,7 +24,7 @@ C Syntax Fortran mpi Module Syntax ^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE MPI @@ -39,7 +39,7 @@ Fortran mpi Module Syntax Fortran mpi_f08 Module Syntax ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. code:: fortran +.. code-block:: fortran USE mpi_f08 @@ -56,8 +56,8 @@ Fortran mpi_f08 Module Syntax PARAMETERS ---------- -- f08_status: mpi_f08-style MPI status object -- f_status: mpi-style INTEGER MPI status object +* ``f08_status`` : mpi_f08-style MPI status object +* ``f_status`` : mpi-style INTEGER MPI status object DESCRIPTION ----------- @@ -68,17 +68,17 @@ These two procedures are provided to convert from a Fortran 2008 status on all the information in status, including that which is hidden. That is, no status information is lost in the conversion. -When using MPI_Status_f082f(), if f08_status is a valid Fortran status, -but not the Fortran value of MPI_F08_STATUS_IGNORE (in C), -MPI_STATUS_IGNORE (in Fortran) or MPI_F08_STATUSES_IGNORE (in C) or -MPI_STATUSES_IGNORE (in Fortran), then MPI_Status_f082f() returns in -f_status a valid array with the same content. If f08_status is the C -value of MPI_F08_STATUS_IGNORE or MPI_F08_STATUSES_IGNORE or the Fortran -value of MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if f08_status is +When using :ref:`MPI_Status_f082f`, if ``f08_status`` is a valid Fortran status, +but not the Fortran value of ``MPI_F08_STATUS_IGNORE`` (in C), +``MPI_STATUS_IGNORE`` (in Fortran) or ``MPI_F08_STATUSES_IGNORE`` (in C) or +``MPI_STATUSES_IGNORE`` (in Fortran), then :ref:`MPI_Status_f082f` returns in +``f_status`` a valid array with the same content. If ``f08_status`` is the C +value of ``MPI_F08_STATUS_IGNORE`` or ``MPI_F08_STATUSES_IGNORE`` or the Fortran +value of ``MPI_STATUS_IGNORE`` or ``MPI_STATUSES_IGNORE``, or if ``f08_status`` is not a valid Fortran status, then the call is erroneous. -When using MPI_Status_f2f08(), the opposite conversion is applied. If -f_status is MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if f_status is +When using :ref:`MPI_Status_f2f08`, the opposite conversion is applied. If +``f_status`` is ``MPI_STATUS_IGNORE`` or ``MPI_STATUSES_IGNORE``, or if ``f_status`` is not a valid Fortran status, then the call is erroneous. The input status has the same source, tag and error code values as the @@ -93,7 +93,7 @@ NOTES The Fortran subroutines for these MPI routines are only available in the mpi and mpi_f08 modules (including the type specification for -TYPE(MPI_Status); they are (intentionally) not available in mpif.h. +``TYPE(MPI_Status)``; they are (intentionally) not available in ``mpif.h``. .. seealso:: :ref:`MPI_Status_c2f` :ref:`MPI_Status_c2f08` diff --git a/docs/man-openmpi/man3/MPI_Status_f2c.3.rst b/docs/man-openmpi/man3/MPI_Status_f2c.3.rst index 821e3893473..55d95193d96 100644 --- a/docs/man-openmpi/man3/MPI_Status_f2c.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_f2c.3.rst @@ -14,7 +14,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -24,8 +24,8 @@ C Syntax PARAMETERS ---------- -- f_status: mpi-style INTEGER MPI status object -- c_status: C-style MPI status object +* ``f_status`` : mpi-style INTEGER MPI status object +* ``c_status`` : C-style MPI status object DESCRIPTION ----------- @@ -36,15 +36,15 @@ and vice versa. The conversion occurs on all the information in status, including that which is hidden. That is, no status information is lost in the conversion. -When using MPI_Status_f2c(), if f_status is a valid Fortran status, but -not the Fortran value of MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, then -MPI_Status_f2c() returns in c_status a valid C status with the same -content. If f_status is the Fortran value of MPI_STATUS_IGNORE or -MPI_STATUSES_IGNORE, or if f_status is not a valid Fortran status, then +When using :ref:`MPI_Status_f2c`, if ``f_status`` is a valid Fortran status, but +not the Fortran value of ``MPI_STATUS_IGNORE`` or ``MPI_STATUSES_IGNORE``, then +:ref:`MPI_Status_f2c` returns in ``c_status`` a valid C status with the same +content. If ``f_status`` is the Fortran value of ``MPI_STATUS_IGNORE`` or +``MPI_STATUSES_IGNORE``, or if ``f_status`` is not a valid Fortran status, then the call is erroneous. -When using MPI_Status_c2f(), the opposite conversion is applied. If -c_status is MPI_STATUS_IGNORE or MPI_STATUSES_IGNORE, or if c_status is +When using :ref:`MPI_Status_c2f`, the opposite conversion is applied. If +``c_status`` is ``MPI_STATUS_IGNORE`` or ``MPI_STATUSES_IGNORE``, or if ``c_status`` is not a valid C status, then the call is erroneous. The input status has the same source, tag and error code values as the 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 b2613adfcbb..3735109c253 100644 --- a/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_set_cancelled.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst b/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst index babe8ac1b5b..23b5d7d7060 100644 --- a/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst +++ b/docs/man-openmpi/man3/MPI_Status_set_elements.3.rst @@ -69,7 +69,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -111,8 +111,9 @@ The MPI standard prescribes portable Fortran syntax for the *COUNT argument of :ref:`MPI_Status_set_elements_x` only for Fortran 90. FORTRAN 77 users may use the non-portable syntax* -:: +.. code-block:: fortran INTEGER*MPI_COUNT_KIND COUNT - where MPI_COUNT_KIND is a constant defined in mpif.h and gives the length of the declared integer in bytes. +where ``MPI_COUNT_KIND`` is a constant defined in ``mpif.h`` and gives the length +of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_T_cvar_handle_alloc.3.rst b/docs/man-openmpi/man3/MPI_T_cvar_handle_alloc.3.rst index aaa5960dbf0..533da153661 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_handle_alloc.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_handle_alloc.3.rst @@ -69,4 +69,4 @@ ERRORS .. seealso:: - :ref:`MPI_T_cvar_get_info` + * :ref:`MPI_T_cvar_get_info` 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 68801b6ff07..ca4ab6a858a 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_read.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_read.3.rst @@ -49,4 +49,5 @@ ERRORS .. seealso:: - :ref:`MPI_T_cvar_handle_alloc` :ref:`MPI_T_cvar_get_info` + * :ref:`MPI_T_cvar_handle_alloc` + * :ref:`MPI_T_cvar_get_info` 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 8a0a64a3644..651008bd635 100644 --- a/docs/man-openmpi/man3/MPI_T_cvar_write.3.rst +++ b/docs/man-openmpi/man3/MPI_T_cvar_write.3.rst @@ -55,4 +55,5 @@ ERRORS .. seealso:: - :ref:`MPI_T_cvar_handle_alloc` :ref:`MPI_T_cvar_get_info` + * :ref:`MPI_T_cvar_handle_alloc` + * :ref:`MPI_T_cvar_get_info` diff --git a/docs/man-openmpi/man3/MPI_T_finalize.3.rst b/docs/man-openmpi/man3/MPI_T_finalize.3.rst index f26c0812490..54246cb5a06 100644 --- a/docs/man-openmpi/man3/MPI_T_finalize.3.rst +++ b/docs/man-openmpi/man3/MPI_T_finalize.3.rst @@ -53,4 +53,4 @@ ERRORS .. seealso:: - :ref:`MPI_T_init_thread` + * :ref:`MPI_T_init_thread` 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 c353e6f5931..3b6e6a5eff3 100644 --- a/docs/man-openmpi/man3/MPI_T_init_thread.3.rst +++ b/docs/man-openmpi/man3/MPI_T_init_thread.3.rst @@ -13,7 +13,7 @@ SYNTAX C Syntax ^^^^^^^^ -.. code:: c +.. code-block:: c #include @@ -22,12 +22,12 @@ C Syntax INPUT PARAMETERS ---------------- -- required: Desired level of thread support (integer). +* ``required``: Desired level of thread support (integer). OUTPUT PARAMETERS ----------------- -- provided: Available level of thread support (integer). +* ``provided``: Available level of thread support (integer). DESCRIPTION ----------- @@ -74,4 +74,7 @@ ERRORS initialized -.. seealso:: :ref:`MPI_T` :ref:`MPI_Init` :ref:`MPI_Init_thread` +.. seealso:: + * :ref:`MPI_T` + * :ref:`MPI_Init` + * :ref:`MPI_Init_thread` 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 3ab1845ce8f..baddfc6343d 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 @@ -194,4 +194,4 @@ ERRORS .. seealso:: - :ref:`MPI_T_cvar_get_info` + * :ref:`MPI_T_cvar_get_info` diff --git a/docs/man-openmpi/man3/MPI_T_pvar_handle_alloc.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_handle_alloc.3.rst index a5fe1710935..45e7d947f49 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_handle_alloc.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_handle_alloc.3.rst @@ -72,4 +72,5 @@ ERRORS .. seealso:: - :ref:`MPI_T_pvar_get_info` :ref:`MPI_T_pvar_get_num` + * :ref:`MPI_T_pvar_get_info` + * :ref:`MPI_T_pvar_get_num` 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 f44c4ec9045..39f147b8684 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_read.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_read.3.rst @@ -52,4 +52,6 @@ ERRORS .. seealso:: - :ref:`MPI_T_pvar_handle_alloc` :ref:`MPI_T_pvar_get_info` :ref:`MPI_T_pvar_session_create` + * :ref:`MPI_T_pvar_handle_alloc` + * :ref:`MPI_T_pvar_get_info` + * :ref:`MPI_T_pvar_session_create` 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 9963d40038c..ddefa503f9c 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_readreset.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_readreset.3.rst @@ -59,5 +59,8 @@ ERRORS .. seealso:: - :ref:`MPI_T_pvar_handle_alloc` :ref:`MPI_T_pvar_get_info` :ref:`MPI_T_pvar_session_create` - :ref:`MPI_T_pvar_read` :ref:`MPI_T_pvar_reset` + * :ref:`MPI_T_pvar_handle_alloc` + * :ref:`MPI_T_pvar_get_info` + * :ref:`MPI_T_pvar_session_create` + * :ref:`MPI_T_pvar_read` + * :ref:`MPI_T_pvar_reset` 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 0a4bc106501..512f2a8a45f 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_reset.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_reset.3.rst @@ -52,5 +52,7 @@ ERRORS .. seealso:: - :ref:`MPI_T_pvar_handle_alloc` :ref:`MPI_T_pvar_get_info` :ref:`MPI_T_pvar_session_create` - :ref:`MPI_T_pvar_write` + * :ref:`MPI_T_pvar_handle_alloc` + * :ref:`MPI_T_pvar_get_info` + * :ref:`MPI_T_pvar_session_create` + * :ref:`MPI_T_pvar_write` diff --git a/docs/man-openmpi/man3/MPI_T_pvar_start.3.rst b/docs/man-openmpi/man3/MPI_T_pvar_start.3.rst index ee8ab5aaaf1..0d14539b067 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_start.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_start.3.rst @@ -62,4 +62,4 @@ ERRORS .. seealso:: - :ref:`MPI_T_pvar_get_info` + * :ref:`MPI_T_pvar_get_info` 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 acfcffe50fc..bdbd4ebb7a4 100644 --- a/docs/man-openmpi/man3/MPI_T_pvar_write.3.rst +++ b/docs/man-openmpi/man3/MPI_T_pvar_write.3.rst @@ -54,4 +54,6 @@ ERRORS .. seealso:: - :ref:`MPI_T_pvar_handle_alloc` :ref:`MPI_T_pvar_get_info` :ref:`MPI_T_pvar_session_create` + * :ref:`MPI_T_pvar_handle_alloc` + * :ref:`MPI_T_pvar_get_info` + * :ref:`MPI_T_pvar_session_create` diff --git a/docs/man-openmpi/man3/MPI_Test.3.rst b/docs/man-openmpi/man3/MPI_Test.3.rst index ab5e3fe2f28..5c181bb11b7 100644 --- a/docs/man-openmpi/man3/MPI_Test.3.rst +++ b/docs/man-openmpi/man3/MPI_Test.3.rst @@ -56,7 +56,7 @@ OUTPUT PARAMETERS ----------------- * ``flag``: True if operation completed (logical). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,7 +65,7 @@ A call to :ref:`MPI_Test` returns flag = true if the operation identified by request is complete. In such a case, the status object is set to contain information on the completed operation; if the communication object was created by a nonblocking send or receive, then it is deallocated and the -request handle is set to MPI_REQUEST_NULL. The call returns flag = +request handle is set to ``MPI_REQUEST_NULL``. The call returns flag = false, otherwise. In this case, the value of the status object is undefined. :ref:`MPI_Test` is a local operation. @@ -76,7 +76,7 @@ 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"). 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. One is allowed to call :ref:`MPI_Test` with a null or inactive *request* @@ -110,6 +110,13 @@ MPI_ERRORS_RETURN exhibits this behavior, for example. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Testall` :ref:`MPI_Testany` - :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst b/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst index e5dae86872d..443bb00b4f4 100644 --- a/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst +++ b/docs/man-openmpi/man3/MPI_Test_cancelled.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``flag``: True if operation was cancelled (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Testall.3.rst b/docs/man-openmpi/man3/MPI_Testall.3.rst index e844a5789d7..d675e0d7e4f 100644 --- a/docs/man-openmpi/man3/MPI_Testall.3.rst +++ b/docs/man-openmpi/man3/MPI_Testall.3.rst @@ -62,7 +62,7 @@ OUTPUT PARAMETERS ----------------- * ``flag``: True if previously initiated communications are complete (logical.) * ``array_of_statuses``: Array of status objects (array of status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -115,6 +115,13 @@ bindings. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testany` - :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Testany.3.rst b/docs/man-openmpi/man3/MPI_Testany.3.rst index b038566a64e..b10bf7ff428 100644 --- a/docs/man-openmpi/man3/MPI_Testany.3.rst +++ b/docs/man-openmpi/man3/MPI_Testany.3.rst @@ -60,10 +60,10 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``index``: Index of operation that completed, or MPI_UNDEFINED if none completed (integer). +* ``index``: Index of operation that completed, or ``MPI_UNDEFINED`` if none completed (integer). * ``flag``: True if one of the operations is complete (logical). * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -73,26 +73,26 @@ associated with active handles. In the former case, it returns *flag* = true, returns in *index* the index of this request in the array, and returns in *status* the status of that operation; if the request was allocated by a nonblocking communication call then the request is -deallocated and the handle is set to MPI_REQUEST_NULL. (The array is +deallocated and the handle is set to ``MPI_REQUEST_NULL``. (The array is indexed from 0 in C, and from 1 in Fortran.) In the latter case (no operation completed), it returns *flag* = false, returns a value of -MPI_UNDEFINED in *index*, and *status* is undefined. +``MPI_UNDEFINED`` in *index*, and *status* is undefined. The array may contain null or inactive handles. If the array contains no active handles then the call returns immediately with *flag* = true, -*index* = MPI_UNDEFINED, and an empty *status*. +*index* = ``MPI_UNDEFINED``, and an empty *status*. If the array of requests contains active handles then the execution of -MPI_Testany(count, array_of_requests, index, status) has the same effect -as the execution of MPI_Test(&\ *array_of_requests[i*], *flag*, -*status*), for *i*\ =0,1,...,count-1, in some arbitrary order, until one -call returns *flag* = true, or all fail. In the former case, *index* is +``MPI_Testany(count, array_of_requests, index, status)`` has the same effect +as the execution of ``MPI_Test(&array_of_requests[i], flag, status)``, +for *i*\ =0,1,...,count-1, in some arbitrary order, until one +call returns ``flag = true``, or all fail. In the former case, *index* is set to the last value of *i*, and in the latter case, it is set to -MPI_UNDEFINED. :ref:`MPI_Testany` with an array containing one active entry is +``MPI_UNDEFINED``. :ref:`MPI_Testany` with an array containing one active entry is equivalent to :ref:`MPI_Test`. 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. @@ -102,13 +102,20 @@ 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 +: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. +``MPI_ERRORS_RETURN`` exhibits this behavior, for example. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` - :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testall` + * :ref:`MPI_Testsome` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Testsome.3.rst b/docs/man-openmpi/man3/MPI_Testsome.3.rst index a523d7fd0c4..59e38716eed 100644 --- a/docs/man-openmpi/man3/MPI_Testsome.3.rst +++ b/docs/man-openmpi/man3/MPI_Testsome.3.rst @@ -65,7 +65,7 @@ OUTPUT PARAMETERS * ``outcount``: Number of completed requests (integer). * ``array_of_indices``: Array of indices of operations that completed (array of integers). * ``array_of_statuses``: Array of status objects for operations that completed (array of status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -137,6 +137,13 @@ caller, the value MPI_ERR_IN_STATUS will be returned in the C and Fortran bindings. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` - :ref:`MPI_Testany` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_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 41de9be79bd..4dbee255825 100644 --- a/docs/man-openmpi/man3/MPI_Topo_test.3.rst +++ b/docs/man-openmpi/man3/MPI_Topo_test.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``top_type``: Topology type of communicator comm (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -68,10 +68,10 @@ The output value *top_type* is one of the following: :: - MPI_GRAPH graph topology - MPI_CART Cartesian topology - MPI_DIST_GRAPH distributed graph topology - MPI_UNDEFINED no topology + MPI_GRAPH graph topology + MPI_CART Cartesian topology + MPI_DIST_GRAPH distributed graph topology + MPI_UNDEFINED no topology ERRORS @@ -80,4 +80,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Graph_create` :ref:`MPI_Cart_create` + * :ref:`MPI_Graph_create` + * :ref:`MPI_Cart_create` diff --git a/docs/man-openmpi/man3/MPI_Type_commit.3.rst b/docs/man-openmpi/man3/MPI_Type_commit.3.rst index 8ce2e3732b7..d7a4e8d8f7d 100644 --- a/docs/man-openmpi/man3/MPI_Type_commit.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_commit.3.rst @@ -51,7 +51,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -65,7 +65,7 @@ different buffers, with different starting addresses. **Example:** The following Fortran code fragment gives examples of using :ref:`MPI_Type_commit`. -:: +.. code-block:: fortran INTEGER type1, type2 CALL MPI_TYPE_CONTIGUOUS(5, MPI_REAL, type1, ierr) diff --git a/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst b/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst index 23d9168e6c8..f5d2cb54279 100644 --- a/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_contiguous.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New datatype (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,7 +72,7 @@ size of the concatenated copies. extent 16, and let count = 3. The type map of the datatype returned by newtype is -:: +.. code-block:: c {(double, 0), (char, 8), (double, 16), (char, 24), (double, 32), (char, 40)]; @@ -82,14 +82,14 @@ i.e., alternating double and char elements, with displacements 0, 8, 16, In general, assume that the type map of oldtype is -:: +.. code-block:: c {(type(0), disp(0)),...,(type(n-1), disp(n-1))}, with extent ex. Then newtype has a type map with count times n entries defined by: -:: +.. code-block:: c {(type(0), disp(0)), ...,(type(n-1), disp(n-1)), (type(0), disp(0) + ex), ...,(type(n-1), 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 7d2d6fa8682..39197dee2cd 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_darray.3.rst @@ -74,7 +74,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -97,11 +97,9 @@ topologies in MPI-1. Each dimension of the array can be distributed in one of three ways: -:: - - - MPI_DISTRIBUTE_BLOCK - Block distribution - - MPI_DISTRIBUTE_CYCLIC - Cyclic distribution - - MPI_DISTRIBUTE_NONE - Dimension not distributed. +* ``MPI_DISTRIBUTE_BLOCK`` - Block distribution +* ``MPI_DISTRIBUTE_CYCLIC`` - Cyclic distribution +* ``MPI_DISTRIBUTE_NONE`` - Dimension not distributed. The constant MPI_DISTRIBUTE_DFLT_DARG specifies a default distribution argument. The distribution argument for a dimension that is not @@ -123,7 +121,7 @@ This routine creates a new MPI data type with a typemap defined in terms of a function called "cyclic()" (see below). Without loss of generality, it suffices to define the typemap for the -MPI_DISTRIBUTE_CYCLIC case where MPI_DISTRIBUTE_DFLT_DARG is not used. +MPI_DISTRIBUTE_CYCLIC case where ``MPI_DISTRIBUTE_DFLT_DARG`` is not used. MPI_DISTRIBUTE_BLOCK and MPI_DISTRIBUTE_NONE can be reduced to the MPI_DISTRIBUTE_CYCLIC case for dimension *i* as follows. @@ -132,7 +130,7 @@ MPI_DISTRIBUTE_BLOCK with *array_of_dargs[i]* equal to MPI_DISTRIBUTE_DFLT_DARG is equivalent to MPI_DISTRIBUTE_CYCLIC with *array_of_dargs[i]* set to -:: +.. code-block:: c (array_of_gsizes[i] + array_of_psizes[i] - 1)/array_of_psizes[i] diff --git a/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst b/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst index d1f8d46da3f..7a3831b69b8 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_f90_complex.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -98,7 +98,7 @@ external32 data representation - used by :ref:`MPI_Pack_external`, :ref:`MPI_Unpack_external`, and many MPI_File functions - is subtle. The external32 representation of returned datatypes is as follows. -:: +.. code-block:: c if (p > 33) and/or (r > 4931): external32 size = n/a (undefined) @@ -127,5 +127,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack_external` :ref:`MPI_Sizeof` :ref:`MPI_Type_match_size` :ref:`MPI_Unpack_external` - SELECTED_REAL_KIND + * :ref:`MPI_Pack_external` + * :ref:`MPI_Sizeof` + * :ref:`MPI_Type_match_size` + * :ref:`MPI_Unpack_external` + * SELECTED_REAL_KIND diff --git a/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst b/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst index cf43121e85e..761a13f0deb 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_f90_integer.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -87,7 +87,7 @@ external32 data representation - used by :ref:`MPI_Pack_external`, :ref:`MPI_Unpack_external` and many MPI_File functions - is subtle. The external32 representation of returned datatypes is as follows. -:: +.. code-block:: c if (r > 38): external32 size = n/a (undefined) @@ -120,5 +120,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack_external` :ref:`MPI_Sizeof` :ref:`MPI_Type_match_size` :ref:`MPI_Unpack_external` - SELECTED_INT_KIND + * :ref:`MPI_Pack_external` + * :ref:`MPI_Sizeof` + * :ref:`MPI_Type_match_size` + * :ref:`MPI_Unpack_external` + * SELECTED_INT_KIND diff --git a/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst b/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst index 881131e60f3..795999cb946 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_f90_real.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -97,7 +97,7 @@ external32 data representation - used by :ref:`MPI_Pack_external`, :ref:`MPI_Unpack_external` and many MPI_File functions - is subtle. The external32 representation of returned datatypes is as follows. -:: +.. code-block:: c if (p > 33) and/or (r > 4931): external32 size = n/a (undefined) @@ -126,5 +126,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack_external` :ref:`MPI_Sizeof` :ref:`MPI_Type_match_size` :ref:`MPI_Unpack_external` - SELECTED_REAL_KIND + * :ref:`MPI_Pack_external` + * :ref:`MPI_Sizeof` + * :ref:`MPI_Type_match_size` + * :ref:`MPI_Unpack_external` + * SELECTED_REAL_KIND 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 71650bbd093..05f198bcf67 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_hvector.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -83,11 +83,11 @@ The MPI standard prescribes portable Fortran syntax for the *STRIDE* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND STRIDE -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -97,4 +97,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_hvector` :ref:`MPI_Type_vector` + * :ref:`MPI_Type_hvector` + * :ref:`MPI_Type_vector` diff --git a/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst b/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst index b964c2924e5..33f3bcb7c79 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_indexed_block.3.rst @@ -79,7 +79,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -97,4 +97,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_indexed` + * :ref:`MPI_Type_indexed` 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 b4e22b3822b..1d54308f73b 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_keyval.3.rst @@ -64,7 +64,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``type_keyval``: Key value for future access (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,16 +84,12 @@ MPI_TYPE_NULL_DELETE_FN from C or Fortran. MPI_TYPE_NULL_DELETE_FN is a function that does nothing beyond returning MPI_SUCCESS. The C callback functions are: -:: +.. code-block:: c typedef int MPI_Type_copy_attr_function(MPI_Datatype oldtype, int type_keyval, void *extra_state, void *attribute_val_in, void *attribute_val_out, int *flag); -and - -:: - typedef int MPI_Type_delete_attr_function(MPI_Datatype type, int type_keyval, void *attribute_val, void *extra_state); @@ -108,10 +104,6 @@ The Fortran callback functions are: ATTRIBUTE_VAL_IN, ATTRIBUTE_VAL_OUT LOGICAL FLAG -and - -:: - SUBROUTINE TYPE_DELETE_ATTR_FN(TYPE, TYPE_KEYVAL, ATTRIBUTE_VAL, EXTRA_STATE, IERROR) INTEGER TYPE, TYPE_KEYVAL, IERROR @@ -125,11 +117,11 @@ The MPI standard prescribes portable Fortran syntax for the *EXTRA_STATE* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND EXTRA_STATE -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -139,4 +131,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_free_keyval` + * :ref:`MPI_Type_free_keyval` 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 91f67332d13..19efb869341 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_resized.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: Output data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -81,13 +81,11 @@ The MPI standard prescribes portable Fortran syntax for the *LB* and *EXTENT* arguments only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_ADDRESS_KIND LB - or - INTEGER*MPI_ADDRESS_KIND EXTENT + INTEGER*MPI_ADDRESS_KIND LB, EXTENT -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -104,4 +102,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_extent` + * :ref:`MPI_Type_get_extent` 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 110c813c852..10ff898cc43 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_struct.3.rst @@ -65,7 +65,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,11 +84,11 @@ The MPI standard prescribes portable Fortran syntax for the *ARRAY_OF_DISPLACEMENTS*\ (*) argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ARRAY_OF_DISPLACEMENTS(*) -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -98,4 +98,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_struct` :ref:`MPI_Type_create_hindexed` + * :ref:`MPI_Type_struct` + * :ref:`MPI_Type_create_hindexed` 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 8f1aa34531f..c48194044f4 100644 --- a/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_create_subarray.3.rst @@ -67,7 +67,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New data type (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -99,13 +99,13 @@ The *array_of_starts* contains the starting coordinates of each dimension of the subarray. Arrays are assumed to be indexed starting from zero. For any dimension *i*, it is erroneous to specify -.. code:: +.. code-block:: array_of_starts[i] < 0 or -.. code:: +.. code-block:: array_of_starts[i] > (array_of_sizes[i] - array_of_subsizes[i]). @@ -119,7 +119,7 @@ well as the full array. It must be set to one of the following: A *ndims*-dimensional subarray (*newtype*) with no extra padding can be defined by the function Subarray() as follows: -.. code:: +.. code-block:: newtype = Subarray(ndims, {size_0, size_1,..., size_ndims-1}, {subsize_0, subsize_1, ..., subsize_ndims-1}, @@ -127,7 +127,7 @@ defined by the function Subarray() as follows: Let the typemap of *oldtype* have the form: -.. code:: +.. code-block:: {(type_0, disp_0), (type_1, disp_1), ..., (type_n-1, disp_n-1)} 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 66beb473d9e..81d8645e627 100644 --- a/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_delete_attr.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Type_dup.3.rst b/docs/man-openmpi/man3/MPI_Type_dup.3.rst index 68e9444bc7e..6aefa2d514a 100644 --- a/docs/man-openmpi/man3/MPI_Type_dup.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_dup.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``newtype``: Copy of *type* (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -86,4 +86,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_create_keyval` + * :ref:`MPI_Type_create_keyval` diff --git a/docs/man-openmpi/man3/MPI_Type_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_extent.3.rst index d7595f60da6..19e46f4d858 100644 --- a/docs/man-openmpi/man3/MPI_Type_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_extent.3.rst @@ -42,7 +42,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``extent``: Datatype extent (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -92,4 +92,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_extent` + * :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_free.3.rst b/docs/man-openmpi/man3/MPI_Type_free.3.rst index 82ead6c964b..91d48d250c9 100644 --- a/docs/man-openmpi/man3/MPI_Type_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_free.3.rst @@ -51,7 +51,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 358a6804898..811e27fa847 100644 --- a/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_free_keyval.3.rst @@ -51,7 +51,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -63,4 +63,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_create_keyval` + * :ref:`MPI_Type_create_keyval` 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 5e9b172d564..b80a8d957e7 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_attr.3.rst @@ -60,7 +60,7 @@ OUTPUT PARAMETERS ----------------- * ``attribute_val``: Attribute value, unless *flag* = false * ``flag``: "false" if no attribute is associated with the key (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -76,11 +76,11 @@ The MPI standard prescribes portable Fortran syntax for the *ATTRIBUTE_VAL* argument only for Fortran 90. Sun FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -90,4 +90,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_set_attr` + * :ref:`MPI_Type_set_attr` 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 dab60eee5ed..6a911a51b19 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_contents.3.rst @@ -70,7 +70,7 @@ OUTPUT PARAMETERS * ``array_of_integers``: Contains integer arguments used in constructing *datatype (array of integers).* * ``array_of_addresses``: Contains address arguments used in constructing *datatype (array of integers).* * ``array_of_datatypes``: Contains data-type arguments used in constructing *datatype (array of integers).* -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -128,11 +128,11 @@ The MPI standard prescribes portable Fortran syntax for the *ARRAY_OF_ADDRESSES argument only for Fortran 90. FORTRAN 77* users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ARRAY_OF_ADDRESSES(*) -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -142,4 +142,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_envelope` + * :ref:`MPI_Type_get_envelope` 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 f983bcbd81b..9a38d613a31 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_envelope.3.rst @@ -62,7 +62,7 @@ OUTPUT PARAMETERS * ``num_addresses``: Number of input addresses used in the call constructing *combiner* (nonnegative integer). * ``num_datatypes``: Number of input data types used in the call constructing *combiner* (nonnegative integer). * ``combiner``: Combiner (state). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -118,4 +118,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_contents` + * :ref:`MPI_Type_get_contents` 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 8536e0252e6..1c00f635c3d 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_extent.3.rst @@ -66,7 +66,7 @@ OUTPUT PARAMETERS ----------------- * ``lb``: Lower bound of data type (integer). * ``extent``: Data type extent (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -94,21 +94,17 @@ non-portable syntax :ref:`MPI_Type_get_extent`: -:: +.. code-block:: fortran - INTEGER*MPI_ADDRESS_KIND LB - or - INTEGER*MPI_ADDRESS_KIND EXTENT + INTEGER*MPI_ADDRESS_KIND LB, EXTENT :ref:`MPI_Type_get_extent_x`: -:: +.. code-block:: fortran - INTEGER*MPI_COUNT_KIND LB - or - INTEGER*MPI_COUNT_KIND EXTENT + INTEGER*MPI_COUNT_KIND LB, EXTENT -where MPI_ADDRESS_KIND and MPI_COUNT_KIND are constants defined in +where ``MPI_ADDRESS_KIND`` and MPI_COUNT_KIND are constants defined in mpif.h and give the length of the declared integer in bytes. 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 e8983dfdf2d..5b3ee5f09dd 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_name.3.rst @@ -57,7 +57,7 @@ OUTPUT PARAMETERS ----------------- * ``type_name``: The name previously stored on the data type, or an empty string if not such name exists (string). * ``resultlen``: Length of returned name (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,4 +72,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_set_name` + * :ref:`MPI_Type_set_name` diff --git a/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst b/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst index 77e6158c420..329e63ce335 100644 --- a/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_get_true_extent.3.rst @@ -67,7 +67,7 @@ OUTPUT PARAMETERS ----------------- * ``true_lb``: True lower bound of data type (integer). * ``true_extent``: True size of data type (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -98,21 +98,18 @@ use the non-portable syntax :ref:`MPI_Type_get_true_extent`: -:: +.. code-block:: fortran - INTEGER*MPI_ADDRESS_KIND TRUE_LB - or - INTEGER*MPI_ADDRESS_KIND TRUE_EXTENT + INTEGER*MPI_ADDRESS_KIND TRUE_LB, TRUE_EXTENT :ref:`MPI_Type_get_true_extent_x`: -:: +.. code-block:: fortran - INTEGER*MPI_COUNT_KIND TRUE_LB - or + INTEGER*MPI_COUNT_KIND TRUE_LB, TRUE_EXTENT INTEGER*MPI_COUNT_KIND TRUE_EXTENT -where MPI_ADDRESS_KIND and MPI_COUNT_KIND are constants defined in +where ``MPI_ADDRESS_KIND`` and MPI_COUNT_KIND are constants defined in mpif.h and give the length of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst index d66d8ffabdd..b682d24daca 100644 --- a/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_hindexed.3.rst @@ -49,7 +49,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New datatype (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -89,4 +89,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_create_hindexed` :ref:`MPI_Type_indexed` + * :ref:`MPI_Type_create_hindexed` + * :ref:`MPI_Type_indexed` diff --git a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst index 97b4b94609f..81e198b129f 100644 --- a/docs/man-openmpi/man3/MPI_Type_hvector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_hvector.3.rst @@ -47,7 +47,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New datatype (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -67,7 +67,7 @@ Assume that oldtype has type map {(type(0), disp(0)), ..., (type(n-1), disp(n-1))} with extent ex. Let bl be the blocklength. The newly created datatype -has a type map with count \* bl \* n entries: +has a type map with ``count * bl * n`` entries: :: @@ -90,4 +90,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_create_hvector` :ref:`MPI_Type_vector` + * :ref:`MPI_Type_create_hvector` + * :ref:`MPI_Type_vector` diff --git a/docs/man-openmpi/man3/MPI_Type_indexed.3.rst b/docs/man-openmpi/man3/MPI_Type_indexed.3.rst index 6f01dcf12db..3f500104957 100644 --- a/docs/man-openmpi/man3/MPI_Type_indexed.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_indexed.3.rst @@ -86,7 +86,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New datatype (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -157,4 +157,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_hindexed` + * :ref:`MPI_Type_hindexed` diff --git a/docs/man-openmpi/man3/MPI_Type_lb.3.rst b/docs/man-openmpi/man3/MPI_Type_lb.3.rst index 44dd1c20533..b49dd6f4ca8 100644 --- a/docs/man-openmpi/man3/MPI_Type_lb.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_lb.3.rst @@ -41,7 +41,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``displacement``: Displacement of lower bound from origin, in bytes (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -99,4 +99,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_extent` + * :ref:`MPI_Type_get_extent` 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 719beec6afd..9c891e18e70 100644 --- a/docs/man-openmpi/man3/MPI_Type_match_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_match_size.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``type``: Datatype with correct type and size (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -83,4 +83,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Sizeof` :ref:`MPI_Type_get_extent` + * :ref:`MPI_Sizeof` + * :ref:`MPI_Type_get_extent` 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 b5d36bee46b..88376869277 100644 --- a/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_set_attr.3.rst @@ -60,7 +60,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -76,11 +76,11 @@ The MPI standard prescribes portable Fortran syntax for the *ATTRIBUTE_VAL* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL + INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -90,4 +90,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_attr` + * :ref:`MPI_Type_get_attr` 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 109b4568449..35d31617a0b 100644 --- a/docs/man-openmpi/man3/MPI_Type_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_set_name.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -69,7 +69,7 @@ type. ERRORS ------ -.. include ./ERRORS.rst +.. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_name` + * :ref:`MPI_Type_get_name` diff --git a/docs/man-openmpi/man3/MPI_Type_size.3.rst b/docs/man-openmpi/man3/MPI_Type_size.3.rst index f5fdfea4945..6fc49d38449 100644 --- a/docs/man-openmpi/man3/MPI_Type_size.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_size.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``size``: Datatype size (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -89,9 +89,9 @@ The MPI standard prescribes portable Fortran syntax for the *SIZE* argument of :ref:`MPI_Type_size_x` only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_COUNT_KIND SIZE -where MPI_COUNT_KIND is a constant defined in mpif.h and gives the +where ``MPI_COUNT_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. diff --git a/docs/man-openmpi/man3/MPI_Type_struct.3.rst b/docs/man-openmpi/man3/MPI_Type_struct.3.rst index 8877bf0fa81..5a11d610d48 100644 --- a/docs/man-openmpi/man3/MPI_Type_struct.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_struct.3.rst @@ -50,7 +50,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New datatype (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -97,13 +97,13 @@ alignment; this was intended to allow the simple definition of structures that could be sent with a count greater than one. For example, -:: +.. code-block:: c struct {int a; char b;} foo; may have -:: +.. code-block:: c sizeof(foo) = sizeof(int) + sizeof(char); @@ -116,8 +116,7 @@ or receive multiple items, you should explicitly include an MPI_UB entry as the last member of the structure. For example, the following code can be used for the structure foo: -:: - +.. code-block:: c blen[0] = 1; indices[0] = 0; oldtypes[0] = MPI_INT; blen[1] = 1; indices[1] = &foo.b - &foo; oldtypes[1] = MPI_CHAR; @@ -131,4 +130,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_create_struct` :ref:`MPI_Type_create_hindexed` + * :ref:`MPI_Type_create_struct` + * :ref:`MPI_Type_create_hindexed` diff --git a/docs/man-openmpi/man3/MPI_Type_ub.3.rst b/docs/man-openmpi/man3/MPI_Type_ub.3.rst index bc4d8a873e9..e20826f2308 100644 --- a/docs/man-openmpi/man3/MPI_Type_ub.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_ub.3.rst @@ -41,7 +41,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``displacement``: Displacement of upper bound from origin, in bytes (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -104,4 +104,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_get_extent` + * :ref:`MPI_Type_get_extent` diff --git a/docs/man-openmpi/man3/MPI_Type_vector.3.rst b/docs/man-openmpi/man3/MPI_Type_vector.3.rst index 1819f480ab9..7f283b03613 100644 --- a/docs/man-openmpi/man3/MPI_Type_vector.3.rst +++ b/docs/man-openmpi/man3/MPI_Type_vector.3.rst @@ -60,7 +60,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``newtype``: New datatype (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -131,4 +131,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Type_create_hvector` :ref:`MPI_Type_hvector` + * :ref:`MPI_Type_create_hvector` + * :ref:`MPI_Type_hvector` diff --git a/docs/man-openmpi/man3/MPI_Unpack.3.rst b/docs/man-openmpi/man3/MPI_Unpack.3.rst index 7ee2ae0b069..c73b65cc393 100644 --- a/docs/man-openmpi/man3/MPI_Unpack.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpack.3.rst @@ -71,7 +71,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``outbuf``: Output buffer start (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -152,4 +152,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack` :ref:`MPI_Pack_size` + * :ref:`MPI_Pack` + * :ref:`MPI_Pack_size` diff --git a/docs/man-openmpi/man3/MPI_Unpack_external.3.rst b/docs/man-openmpi/man3/MPI_Unpack_external.3.rst index 0b1ce029049..6e59b233cd2 100644 --- a/docs/man-openmpi/man3/MPI_Unpack_external.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpack_external.3.rst @@ -75,7 +75,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``outbuf``: Output buffer start (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -157,4 +157,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Pack_external` :ref:`MPI_Pack_external_size` :ref:`MPI_Recv` sscanf(3C) + * :ref:`MPI_Pack_external` + * :ref:`MPI_Pack_external_size` + * :ref:`MPI_Recv` + * sscanf(3C) diff --git a/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst b/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst index e24caf41ea8..395fa5fcb95 100644 --- a/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Unpublish_name.3.rst @@ -58,7 +58,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -120,4 +120,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Publish_name` :ref:`MPI_Lookup_name` :ref:`MPI_Open_port` + * :ref:`MPI_Publish_name` + * :ref:`MPI_Lookup_name` + * :ref:`MPI_Open_port` diff --git a/docs/man-openmpi/man3/MPI_Wait.3.rst b/docs/man-openmpi/man3/MPI_Wait.3.rst index d4bf08807a1..63ff8d30eae 100644 --- a/docs/man-openmpi/man3/MPI_Wait.3.rst +++ b/docs/man-openmpi/man3/MPI_Wait.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -62,7 +62,7 @@ A call to :ref:`MPI_Wait` returns when the operation identified by request is complete. If the communication object associated with this request was 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. +``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 @@ -72,7 +72,7 @@ status object for a send operation may be queried by a call to Cancel"). 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. One is allowed to call :ref:`MPI_Wait` with a null or inactive request @@ -94,7 +94,7 @@ that was committed to the communication subsystem). Example: Simple usage of nonblocking operations and :ref:`MPI_Wait`. -:: +.. code-block:: fortran CALL MPI_COMM_RANK(comm, rank, ierr) IF(rank.EQ.0) THEN @@ -114,14 +114,21 @@ 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. +: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. +``MPI_ERRORS_RETURN`` exhibits this behavior, for example. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` - :ref:`MPI_Testany` :ref:`MPI_Testsome` :ref:`MPI_Waitall` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Waitall.3.rst b/docs/man-openmpi/man3/MPI_Waitall.3.rst index 360d1ea1a6e..a3cb42d0939 100644 --- a/docs/man-openmpi/man3/MPI_Waitall.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitall.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``array_of_statuses``: Array of status objects (array of status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -115,6 +115,13 @@ bindings. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` - :ref:`MPI_Testany` :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitany` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitany` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Waitany.3.rst b/docs/man-openmpi/man3/MPI_Waitany.3.rst index ad0eb895e9e..469eafb1798 100644 --- a/docs/man-openmpi/man3/MPI_Waitany.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitany.3.rst @@ -59,7 +59,7 @@ OUTPUT PARAMETERS ----------------- * ``index``: Index of handle for operation that completed (integer). In the range 0 to count-1. In Fortran, the range is 1 to count. * ``status``: Status object (status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -70,21 +70,21 @@ of several requests. The array_of_requests list may contain null or inactive handles. If the list contains no active handles (list has length zero or all entries are null or inactive), then the call returns immediately with index = -MPI_UNDEFINED, and an empty status. +``MPI_UNDEFINED``, and an empty status. The execution of MPI_Waitany(count, array_of_requests, index, status) -has the same effect as the execution of MPI_Wait(&array_of_requests[i], -status), where i is the value returned by index (unless the value of -index is MPI_UNDEFINED). :ref:`MPI_Waitany` with an array containing one active +has the same effect as the execution of ``MPI_Wait(&array_of_requests[i], status)``, +where i is the value returned by index (unless the value of +index is ``MPI_UNDEFINED``). :ref:`MPI_Waitany` with an array containing one active entry is equivalent to :ref:`MPI_Wait`. 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 +save resources by using the predefined constant ``MPI_STATUS_IGNORE`` as a special value for the *status* argument. **Example:** Client-server code (starvation can occur). -:: +.. code-block:: fortran CALL MPI_COMM_SIZE(comm, size, ierr) CALL MPI_COMM_RANK(comm, rank, ierr) @@ -113,14 +113,21 @@ 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 +: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. +``MPI_ERRORS_RETURN`` exhibits this behavior, for example. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` - :ref:`MPI_Testany` :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitsome` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitsome` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Waitsome.3.rst b/docs/man-openmpi/man3/MPI_Waitsome.3.rst index 24a27022444..28b391fa8f4 100644 --- a/docs/man-openmpi/man3/MPI_Waitsome.3.rst +++ b/docs/man-openmpi/man3/MPI_Waitsome.3.rst @@ -65,7 +65,7 @@ OUTPUT PARAMETERS * ``outcount``: Number of completed requests (integer). * ``array_of_indices``: Array of indices of operations that completed (array of integers). * ``array_of_statuses``: Array of status objects for operations that completed (array of status). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -104,7 +104,7 @@ MPI_STATUSES_IGNORE can be used as a special value for the **Example:** Same code as the example in the :ref:`MPI_Waitany` man page, but using :ref:`MPI_Waitsome`. -:: +.. code-block:: fortran CALL MPI_COMM_SIZE(comm, size, ierr) CALL MPI_COMM_RANK(comm, rank, ierr) @@ -156,6 +156,13 @@ Fortran bindings. .. seealso:: - :ref:`MPI_Comm_set_errhandler` :ref:`MPI_File_set_errhandler` :ref:`MPI_Test` :ref:`MPI_Testall` - :ref:`MPI_Testany` :ref:`MPI_Testsome` :ref:`MPI_Wait` :ref:`MPI_Waitall` :ref:`MPI_Waitany` - :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Comm_set_errhandler` + * :ref:`MPI_File_set_errhandler` + * :ref:`MPI_Test` + * :ref:`MPI_Testall` + * :ref:`MPI_Testany` + * :ref:`MPI_Testsome` + * :ref:`MPI_Wait` + * :ref:`MPI_Waitall` + * :ref:`MPI_Waitany` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Win_allocate.3.rst b/docs/man-openmpi/man3/MPI_Win_allocate.3.rst index c1303141de8..cf54d21a577 100644 --- a/docs/man-openmpi/man3/MPI_Win_allocate.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_allocate.3.rst @@ -65,7 +65,7 @@ OUTPUT PARAMETERS ----------------- * ``baseptr``: Initial address of window. * ``win``: Window object returned by the call (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -90,7 +90,7 @@ arithmetic in RMA operations: the target displacement argument of an RMA operation is scaled by the factor *disp_unit* specified by the target process, at window creation. -For supported info keys see :ref:`MPI_Win_create`\ *.* +For supported info keys see :ref:`MPI_Win_create`. NOTES @@ -102,17 +102,17 @@ type *type. The later choice will allow one to use* array indices in RMA calls, and have those scaled correctly to byte displacements, even in a heterogeneous environment. -Calling :ref:`MPI_Win_free`\ *will deallocate the memory allocated -by*\ :ref:`MPI_Win_allocate`\ *. It is thus erroneous to manually free -baseptr.* +Calling :ref:`MPI_Win_free` will deallocate the memory allocated +by :ref:`MPI_Win_allocate`. It is thus erroneous to manually free +baseptr. C NOTES ------- -While *baseptr is a void \* type, this is to allow easy use of any -pointer object for this parameter. This argument is really a void \*\* -type.* +While *baseptr* is a ``void *`` type, this is to allow easy use of any +pointer object for this parameter. This argument is really a ``void **`` +type. ERRORS @@ -121,5 +121,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alloc_mem` :ref:`MPI_Free_mem` :ref:`MPI_Win_create` :ref:`MPI_Win_allocate_shared` - :ref:`MPI_Win_free` + * :ref:`MPI_Alloc_mem` + * :ref:`MPI_Free_mem` + * :ref:`MPI_Win_create` + * :ref:`MPI_Win_allocate_shared` + * :ref:`MPI_Win_free` 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 50bf97ce264..86fd9bbcadf 100644 --- a/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_allocate_shared.3.rst @@ -65,7 +65,7 @@ OUTPUT PARAMETERS ----------------- * ``baseptr``: Initial address of window. * ``win``: Window object returned by the call (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -130,8 +130,8 @@ Calling :ref:`MPI_Win_free` will deallocate the memory allocated by C NOTES ------- -While *baseptr* is a *void \** type, this is to allow easy use of any -pointer object for this parameter. This argument is really a *void \*\** +While *baseptr* is a ``void *`` type, this is to allow easy use of any +pointer object for this parameter. This argument is really a ``void **`` type. @@ -141,5 +141,9 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alloc_mem` :ref:`MPI_Free_mem` :ref:`MPI_Win_allocate` :ref:`MPI_Win_create` - :ref:`MPI_Win_shared_query` :ref:`MPI_Win_free` + * :ref:`MPI_Alloc_mem` + * :ref:`MPI_Free_mem` + * :ref:`MPI_Win_allocate` + * :ref:`MPI_Win_create` + * :ref:`MPI_Win_shared_query` + * :ref:`MPI_Win_free` diff --git a/docs/man-openmpi/man3/MPI_Win_attach.3.rst b/docs/man-openmpi/man3/MPI_Win_attach.3.rst index 2afcd093b7d..fc00d4ee42d 100644 --- a/docs/man-openmpi/man3/MPI_Win_attach.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_attach.3.rst @@ -70,7 +70,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``win``: Window object returned by the call (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 0cdc9226bb1..10ba9307082 100644 --- a/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_call_errhandler.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -80,4 +80,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_create_errhandler` :ref:`MPI_Win_set_errhandler` + * :ref:`MPI_Win_create_errhandler` + * :ref:`MPI_Win_set_errhandler` diff --git a/docs/man-openmpi/man3/MPI_Win_complete.3.rst b/docs/man-openmpi/man3/MPI_Win_complete.3.rst index 2c9414e1d8b..19b2c562942 100644 --- a/docs/man-openmpi/man3/MPI_Win_complete.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_complete.3.rst @@ -51,7 +51,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -69,4 +69,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_start` + * :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 08850a7b30e..957018e362e 100644 --- a/docs/man-openmpi/man3/MPI_Win_create.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create.3.rst @@ -65,7 +65,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``win``: Window object returned by the call (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -145,11 +145,11 @@ The MPI standard prescribes portable Fortran syntax for the *SIZE* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran - INTEGER*MPI_ADDRESS_KIND SIZE + INTEGER*MPI_ADDRESS_KIND SIZE -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. @@ -159,4 +159,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alloc_mem` :ref:`MPI_Free_mem` :ref:`MPI_Win_allocate` :ref:`MPI_Win_allocate_shared` + * :ref:`MPI_Alloc_mem` + * :ref:`MPI_Free_mem` + * :ref:`MPI_Win_allocate` + * :ref:`MPI_Win_allocate_shared` 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 599896e7ce2..9163e06fec6 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_dynamic.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``win``: Window object returned by the call (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -114,4 +114,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_attach` :ref:`MPI_Win_detach` :ref:`MPI_Get_address` + * :ref:`MPI_Win_attach` + * :ref:`MPI_Win_detach` + * :ref:`MPI_Get_address` 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 abd01cfe3ae..f0ad516bfb8 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_errhandler.3.rst @@ -51,28 +51,29 @@ Fortran 2008 Syntax DEPRECATED TYPE NAME NOTE ------------------------- -MPI-2.2 deprecated the MPI_Win_errhandler_fn and MPI::Win::Errhandler_fn -types in favor of MPI_Win_errhandler_function and -MPI::Win::Errhandler_function, respectively. Open MPI supports both -names (indeed, the \_fn names are typedefs to the \_function names). +MPI-2.2 deprecated the ``MPI_Win_errhandler_fn`` type in favor of +``MPI_Win_errhandler_function``. Open MPI supports both +names (indeed, the ``_fn`` names are typedefs to the ``_function`` names). INPUT PARAMETER --------------- + * ``function``: User-defined error-handling procedure (function). OUTPUT PARAMETERS ----------------- + * ``errhandler``: MPI error handler (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- :ref:`MPI_Win_create_errhandler` should be, in C, a function of type -MPI_Win_errhandler_function, which is defined as +``MPI_Win_errhandler_function``, which is defined as -:: +.. code-block:: c typedef void MPI_Win_errhandler_function(MPI Win *, int *, ...); 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 3c1a50c77a8..37b593a7745 100644 --- a/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_create_keyval.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``win_keyval``: Key value for future access (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -87,10 +87,6 @@ The C callback functions are: void *extra_state, void *attribute_val_in, void *attribute_val_out, int *flag); -and - -:: - typedef int MPI_Win_delete_attr_function(MPI_Win win, int win_keyval, void *attribute_val, void *extra_state); @@ -105,10 +101,6 @@ The Fortran callback functions are: ATTRIBUTE_VAL_OUT LOGICAL FLAG -and - -:: - SUBROUTINE WIN_DELETE_ATTR_FN(WIN, WIN_KEYVAL, ATTRIBUTE_VAL, EXTRA_STATE, IERROR) INTEGER WIN, WIN_KEYVAL, IERROR @@ -122,11 +114,11 @@ The MPI standard prescribes portable Fortran syntax for the *EXTRA_STATE* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND EXTRA_STATE -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 2c2128ed642..60ae4c26b45 100644 --- a/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_delete_attr.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). NOTES ----- diff --git a/docs/man-openmpi/man3/MPI_Win_fence.3.rst b/docs/man-openmpi/man3/MPI_Win_fence.3.rst index 87554e76622..99af4bf9b47 100644 --- a/docs/man-openmpi/man3/MPI_Win_fence.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_fence.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -116,4 +116,8 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_create` :ref:`MPI_Win_start` :ref:`MPI_Win_post` :ref:`MPI_Win_complete` :ref:`MPI_Win_wait` + * :ref:`MPI_Win_create` + * :ref:`MPI_Win_start` + * :ref:`MPI_Win_post` + * :ref:`MPI_Win_complete` + * :ref:`MPI_Win_wait` diff --git a/docs/man-openmpi/man3/MPI_Win_flush.3.rst b/docs/man-openmpi/man3/MPI_Win_flush.3.rst index 51ab29ee531..97b8d706928 100644 --- a/docs/man-openmpi/man3/MPI_Win_flush.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_flush.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -83,4 +83,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_flush_local` :ref:`MPI_Win_lock` :ref:`MPI_Win_lock_all` + * :ref:`MPI_Win_flush_local` + * :ref:`MPI_Win_lock` + * :ref:`MPI_Win_lock_all` diff --git a/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst b/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst index fafee2885fe..0c87e62b082 100644 --- a/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_flush_local.3.rst @@ -63,7 +63,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,4 +84,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_flush` :ref:`MPI_Win_lock` :ref:`MPI_Win_lock_all` + * :ref:`MPI_Win_flush` + * :ref:`MPI_Win_lock` + * :ref:`MPI_Win_lock_all` diff --git a/docs/man-openmpi/man3/MPI_Win_free.3.rst b/docs/man-openmpi/man3/MPI_Win_free.3.rst index 86d5b3624f1..9f8829392dc 100644 --- a/docs/man-openmpi/man3/MPI_Win_free.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_free.3.rst @@ -51,7 +51,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -79,4 +79,6 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_create` :ref:`MPI_Win_allocate` :ref:`MPI_Win_allocate_shared` + * :ref:`MPI_Win_create` + * :ref:`MPI_Win_allocate` + * :ref:`MPI_Win_allocate_shared` 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 7a1fa3019c0..431454e23d0 100644 --- a/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_free_keyval.3.rst @@ -51,7 +51,7 @@ INPUT/OUTPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). ERRORS ------ 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 9a5de2029dd..c6bc36e26f9 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_attr.3.rst @@ -60,7 +60,7 @@ OUTPUT PARAMETERS ----------------- * ``attribute_val``: Attribute value, unless *ag* = false * ``flag``: False if no attribute is associated with the key (logical). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -75,11 +75,11 @@ The MPI standard prescribes portable Fortran syntax for the *ATTRIBUTE_VAL* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 97522d03b5e..a0ad705479e 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_errhandler.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``errhandler``: Error handler currently associated with window (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 806eb74f35f..db5c8821394 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_group.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_group.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETER OUTPUT PARAMETERS ----------------- * ``group``: Group of processes that share access to the window (handle). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 36de3883ccf..c5699f3873d 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_info.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- * ``info_used``: New info object returned with all active hints on this window. -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,4 +72,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_set_info` :ref:`MPI_Win_free` + * :ref:`MPI_Win_set_info` + * :ref:`MPI_Win_free` 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 197fd16a0cc..0e1492fe055 100644 --- a/docs/man-openmpi/man3/MPI_Win_get_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_get_name.3.rst @@ -56,7 +56,7 @@ OUTPUT PARAMETERS ----------------- * ``win_name``: the name previously stored on the window, or an empty string if no such name exists (string). * ``resultlen``: Length of returned name (integer). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Win_lock.3.rst b/docs/man-openmpi/man3/MPI_Win_lock.3.rst index 9cb96cfd893..55bcc1071d8 100644 --- a/docs/man-openmpi/man3/MPI_Win_lock.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_lock.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -100,4 +100,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_unlock` :ref:`MPI_Win_lock_all` + * :ref:`MPI_Win_unlock` + * :ref:`MPI_Win_lock_all` 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 5da8cc5365a..4b33d419c4e 100644 --- a/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_lock_all.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -101,4 +101,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_unlock_all` :ref:`MPI_Win_lock` + * :ref:`MPI_Win_unlock_all` + * :ref:`MPI_Win_lock` diff --git a/docs/man-openmpi/man3/MPI_Win_post.3.rst b/docs/man-openmpi/man3/MPI_Win_post.3.rst index c3b0f1aa76d..87f6bf6cd25 100644 --- a/docs/man-openmpi/man3/MPI_Win_post.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_post.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -91,4 +91,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_start` :ref:`MPI_Win_wait` + * :ref:`MPI_Win_start` + * :ref:`MPI_Win_wait` 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 6d90e117d59..4cfa6445e03 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_attr.3.rst @@ -59,7 +59,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -72,11 +72,11 @@ The MPI standard prescribes portable Fortran syntax for the *ATTRIBUTE_VAL* argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax -:: +.. code-block:: fortran INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL -where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the +where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the length of the declared integer in bytes. 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 7e8990f0840..756ae402a3a 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_errhandler.3.rst @@ -56,7 +56,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 806105995db..19dacdeb3b7 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_info.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_info.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -71,4 +71,7 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_get_info` :ref:`MPI_Info_create` :ref:`MPI_Info_set` :ref:`MPI_Info_free` + * :ref:`MPI_Win_get_info` + * :ref:`MPI_Info_create` + * :ref:`MPI_Info_set` + * :ref:`MPI_Info_free` 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 f16fda9e8f7..315cf6e78d3 100644 --- a/docs/man-openmpi/man3/MPI_Win_set_name.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_set_name.3.rst @@ -57,7 +57,7 @@ INPUT PARAMETER OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- 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 f4c4300cb7d..a4da17bfdc5 100644 --- a/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_shared_query.3.rst @@ -55,14 +55,14 @@ Fortran 2008 Syntax INPUT PARAMETERS ---------------- * ``win``: Shared memory window object (handle). -* ``rank``: Rank in the group of window *win* (non-negative integer) or MPI_PROC_NULL. +* ``rank``: Rank in the group of window *win* (non-negative integer) or ``MPI_PROC_NULL``. OUTPUT PARAMETERS ----------------- * ``size``: Size of the window segment (non-negative integer). * ``disp_unit``: Local unit size for displacements, in bytes (positive integer). * ``baseptr``: Address for load/store access to window segment (choice). -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -76,7 +76,7 @@ subject to the constraints defined in MPI-3.1 section 11.7. This function can only be called with windows of flavor MPI_WIN_FLAVOR_SHARED. If the passed window is not of flavor MPI_WIN_FLAVOR_SHARED, the error MPI_ERR_RMA_FLAVOR is raised. When -rank is MPI_PROC_NULL, the *pointer*, *disp_unit*, and *size* returned +rank is ``MPI_PROC_NULL``, the *pointer*, *disp_unit*, and *size* returned are the pointer, disp_unit, and size of the memory segment belonging the lowest rank that specified *size* > 0. If all processes in the group attached to the window specified *size* = 0, then the call @@ -87,9 +87,9 @@ called with *size* = 0. C NOTES ------- -The parameter *baseptr* is of type *void \** to allow passing any +The parameter *baseptr* is of type ``void *`` to allow passing any pointer object for this parameter. The provided argument should be a -pointer to a pointer of arbitrary type (e.g. *void \*\**). +pointer to a pointer of arbitrary type (e.g. ``void **``). ERRORS @@ -98,4 +98,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Alloc_mem` :ref:`MPI_Win_allocate_shared` + * :ref:`MPI_Alloc_mem` + * :ref:`MPI_Win_allocate_shared` diff --git a/docs/man-openmpi/man3/MPI_Win_start.3.rst b/docs/man-openmpi/man3/MPI_Win_start.3.rst index de119baa408..bcfd738da7f 100644 --- a/docs/man-openmpi/man3/MPI_Win_start.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_start.3.rst @@ -55,7 +55,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -84,4 +84,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_post` :ref:`MPI_Win_complete` + * :ref:`MPI_Win_post` + * :ref:`MPI_Win_complete` diff --git a/docs/man-openmpi/man3/MPI_Win_sync.3.rst b/docs/man-openmpi/man3/MPI_Win_sync.3.rst index b9ccbf04d01..890b84515bc 100644 --- a/docs/man-openmpi/man3/MPI_Win_sync.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_sync.3.rst @@ -52,7 +52,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- diff --git a/docs/man-openmpi/man3/MPI_Win_test.3.rst b/docs/man-openmpi/man3/MPI_Win_test.3.rst index 334f4178311..f01f006c22e 100644 --- a/docs/man-openmpi/man3/MPI_Win_test.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_test.3.rst @@ -53,7 +53,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). * ``flag``: The returning state of the test for epoch closure. DESCRIPTION @@ -77,4 +77,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_post` :ref:`MPI_Win_wait` + * :ref:`MPI_Win_post` + * :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 64405d688e9..31c139a9a0c 100644 --- a/docs/man-openmpi/man3/MPI_Win_unlock.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_unlock.3.rst @@ -54,7 +54,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -79,4 +79,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_lock` :ref:`MPI_Win_unlock_all` + * :ref:`MPI_Win_lock` + * :ref:`MPI_Win_unlock_all` 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 3c389d2057c..507972bfb71 100644 --- a/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_unlock_all.3.rst @@ -52,7 +52,7 @@ INPUT PARAMETERS OUTPUT PARAMETER ---------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -77,4 +77,5 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_lock_all` :ref:`MPI_Win_unlock` + * :ref:`MPI_Win_lock_all` + * :ref:`MPI_Win_unlock` diff --git a/docs/man-openmpi/man3/MPI_Win_wait.3.rst b/docs/man-openmpi/man3/MPI_Win_wait.3.rst index e559ba0675a..9449dcc95fa 100644 --- a/docs/man-openmpi/man3/MPI_Win_wait.3.rst +++ b/docs/man-openmpi/man3/MPI_Win_wait.3.rst @@ -52,7 +52,7 @@ INPUT PARAMETERS OUTPUT PARAMETERS ----------------- -* ``IERROR``: Fortran only: Error status (integer). +* ``ierror``: Fortran only: Error status (integer). DESCRIPTION ----------- @@ -74,4 +74,4 @@ ERRORS .. include:: ./ERRORS.rst .. seealso:: - :ref:`MPI_Win_post` + * :ref:`MPI_Win_post` diff --git a/docs/man-openmpi/man3/MPI_Wtick.3.rst b/docs/man-openmpi/man3/MPI_Wtick.3.rst index 1d8b421af1d..0b28c7fa0e4 100644 --- a/docs/man-openmpi/man3/MPI_Wtick.3.rst +++ b/docs/man-openmpi/man3/MPI_Wtick.3.rst @@ -66,4 +66,4 @@ of calling it before :ref:`MPI_Init` or after :ref:`MPI_Finalize` is undefined. .. seealso:: - :ref:`MPI_Wtime` + * :ref:`MPI_Wtime` diff --git a/docs/man-openmpi/man3/MPI_Wtime.3.rst b/docs/man-openmpi/man3/MPI_Wtime.3.rst index 0b6bc535c64..70f35297fc8 100644 --- a/docs/man-openmpi/man3/MPI_Wtime.3.rst +++ b/docs/man-openmpi/man3/MPI_Wtime.3.rst @@ -62,7 +62,7 @@ This function is portable (it returns seconds, not "ticks"), it allows high resolution, and carries no unnecessary baggage. One would use it like this: -:: +.. code-block:: c { double starttime, endtime; @@ -112,4 +112,4 @@ of calling it before :ref:`MPI_Init` or after :ref:`MPI_Finalize` is undefined. .. seealso:: - :ref:`MPI_Wtick` + * :ref:`MPI_Wtick` diff --git a/docs/man-openmpi/man3/OMPI_Affinity_str.3.rst b/docs/man-openmpi/man3/OMPI_Affinity_str.3.rst index 774d1fe3bd1..6e3db7998cd 100644 --- a/docs/man-openmpi/man3/OMPI_Affinity_str.3.rst +++ b/docs/man-openmpi/man3/OMPI_Affinity_str.3.rst @@ -92,7 +92,7 @@ EXAMPLES **Example 1:** Print out processes binding using resource string format. -:: +.. code-block:: c int rank; char ompi_bound[OMPI_AFFINITY_STRING_MAX]; @@ -111,7 +111,7 @@ EXAMPLES rank, ompi_bound, current_binding, exists); ... -Output of mpirun -n 2 -bind-to-core a.out: +Output of ``mpirun -n 2 -bind-to-core a.out``: :: @@ -124,7 +124,7 @@ Output of mpirun -n 2 -bind-to-core a.out: current_binding: socket 0[core 1] exists: socket 0 has 4 cores -Output of mpirun -n 2 -bind-to-socket a.out: +Output of ``mpirun -n 2 -bind-to-socket a.out``: :: @@ -140,7 +140,7 @@ Output of mpirun -n 2 -bind-to-socket a.out: | | **Example 2:** Print out processes binding using layout string format. -:: +.. code-block:: c int rank; char ompi_bound[OMPI_AFFINITY_STRING_MAX]; @@ -159,7 +159,7 @@ Output of mpirun -n 2 -bind-to-socket a.out: rank, ompi_bound, current_binding, exists); ... -Output of mpirun -n 2 -bind-to-core a.out: +Output of ``mpirun -n 2 -bind-to-core a.out``: :: @@ -172,7 +172,7 @@ Output of mpirun -n 2 -bind-to-core a.out: current_binding: [. B . .] exists: [. . . .] -Output of mpirun -n 2 -bind-to-socket a.out: +Output of ``mpirun -n 2 -bind-to-socket a.out``: :: @@ -186,4 +186,4 @@ Output of mpirun -n 2 -bind-to-socket a.out: exists: [. . . .] -.. seealso:: mpirun(1) +.. seealso:: :ref:`mpirun(1) ` diff --git a/docs/man-openmpi/man5/Open-MPI.5.rst b/docs/man-openmpi/man5/Open-MPI.5.rst index 614600d7d58..056d0577ef3 100644 --- a/docs/man-openmpi/man5/Open-MPI.5.rst +++ b/docs/man-openmpi/man5/Open-MPI.5.rst @@ -53,6 +53,9 @@ For a complete listing of MCA parameters and their descriptions, issue the command ``ompi_info --all``. See :ref:`ompi_info(1) ` for more information. + +.. _open-mpi-errors: + ERRORS ------ @@ -75,7 +78,7 @@ Standard error return classes for Open MPI: :header-rows: 1 * - Error name - - Error value + - Value - Description * - MPI_SUCCESS @@ -190,7 +193,7 @@ Standard error return classes for Open MPI: - 27 - Conversion functions could not be registered because a data representation identifier that was already defined was passed - to :ref:`MPI_REGISTER_DATAREP(3) `. + to :ref:`MPI_Register_datarep(3) `. * - MPI_ERR_FILE_EXISTS - 28 @@ -294,8 +297,8 @@ Standard error return classes for Open MPI: * - MPI_ERR_UNSUPPORTED_DATAREP - 51 - - Unsupported datarep passed to :ref:`MPI_FILE_SET_VIEW(3) - `. + - Unsupported datarep passed to :ref:`MPI_File_set_view(3) + `. * - MPI_ERR_UNSUPPORTED_OPERATION - 52 @@ -365,8 +368,8 @@ Standard error return classes for Open MPI: * - MPI_ERR_RMA_RANGE - 68 - Target memory is not part of the window (in the case of a - window created with :ref:`MPI_WIN_CREATE_DYNAMIC(4) - `, target memory is not attached. + window created with :ref:`MPI_Win_create_dynamic(3) + `, target memory is not attached. * - MPI_ERR_RMA_ATTACH - 69