New round of man pages from Harumi

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
open-mpi · Feb 12, 2022 · b8a4a8c · b8a4a8c
1 parent 161ec5d
commit b8a4a8c
Show file tree

Hide file tree

Showing 613 changed files with 1,106 additions and 2,116 deletions.
diff --git a/docs/man-openmpi/man1/mpif77.1.rst b/docs/man-openmpi/man1/mpif77.1.rst
@@ -30,5 +30,5 @@ With *mpifort*, you can compile any Fortran program that uses the
 See mpifort(1) for more details.
 
 
-.. seealso:: 
+.. seealso::
    mpifort(1)
diff --git a/docs/man-openmpi/man1/opal_wrapper.1.rst b/docs/man-openmpi/man1/opal_wrapper.1.rst
@@ -33,7 +33,7 @@ and **mpif77.openmpi**), **mpicxx.openmpi**, **mpiCC.openmpi**,
 **ortecc**, and **ortec++**,
 
 
-.. seealso:: 
+.. seealso::
    The following may exist depending on your particular Open MPI
    installation: **mpicc**\ (1), **mpiCC**\ (1), **mpic++**\ (1),
    **mpifort**\ (1), **mpifort.openmpi**\ (1), **mpicxx.openmpi**\ (1),

diff --git a/docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst b/docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst
@@ -18,7 +18,6 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
    #include <mpi-ext.h>
@@ -73,5 +72,5 @@ Examples
    }
 
 
-.. seealso:: 
+.. seealso::
    ::
diff --git a/docs/man-openmpi/man3/MPI_Abort.3.rst b/docs/man-openmpi/man3/MPI_Abort.3.rst
@@ -17,17 +17,16 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Abort(MPI_Comm comm, int errorcode)
 
 
 Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -39,7 +38,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Abort(comm, errorcode, ierror)

diff --git a/docs/man-openmpi/man3/MPI_Accumulate.3.rst b/docs/man-openmpi/man3/MPI_Accumulate.3.rst
@@ -18,9 +18,9 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Accumulate(const void *origin_addr, int origin_count,
    	MPI_Datatype origin_datatype, int target_rank,
    	MPI_Aint target_disp, int target_count,
@@ -37,7 +37,6 @@ Fortran Syntax (see FORTRAN 77 NOTES)
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -60,7 +59,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Accumulate(origin_addr, origin_count, origin_datatype, target_rank,
@@ -182,5 +180,5 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    :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
@@ -19,17 +19,16 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Add_error_class(int *errorclass)
 
 
 Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -41,7 +40,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Add_error_class(errorclass, ierror)
@@ -93,7 +91,7 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    ::
 
    MPI_Add_error_code

diff --git a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst
@@ -18,17 +18,16 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Add_error_code(int errorclass, int *errorcode)
 
 
 Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -40,7 +39,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Add_error_code(errorclass, errorcode, ierror)
@@ -88,7 +86,7 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    ::
 
    MPI_Add_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
@@ -19,17 +19,16 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Add_error_string(int errorcode, const char *string)
 
 
 Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -42,7 +41,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Add_error_string(errorcode, string, ierror)
@@ -85,7 +83,7 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    ::
 
    MPI_Add_error_class

diff --git a/docs/man-openmpi/man3/MPI_Address.3.rst b/docs/man-openmpi/man3/MPI_Address.3.rst
@@ -18,17 +18,16 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Address(void *location, MPI_Aint *address)
 
 
 Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    INCLUDE 'mpif.h'
    MPI_ADDRESS(LOCATION, ADDRESS, IERROR)
@@ -101,5 +100,5 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    | :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
@@ -18,9 +18,9 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    MPI_Aint MPI_Aint_add(MPI_Aint base, MPI_Aint disp)
 
    MPI_Aint MPI_Aint_diff(MPI_Aint addr1, MPI_Aint addr2)
@@ -30,7 +30,6 @@ Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -45,7 +44,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    INTEGER(KIND=MPI_ADDRESS_KIND) MPI_AINT_ADD(BASE, DISP)
@@ -91,5 +89,5 @@ originally produced the addresses had called (char \*) *addr1* - (char
 \*) *addr2* on the addresses initially passed to :ref:`MPI_Get_address`.
 
 
-.. seealso:: 
+.. seealso::
    :ref:`MPI_Get_address`
diff --git a/docs/man-openmpi/man3/MPI_Aint_diff.3.rst b/docs/man-openmpi/man3/MPI_Aint_diff.3.rst
@@ -1,8 +1,7 @@
 .. _mpi_aint_diff:
-
+ 
 MPI_Aint_diff
 =============
-
     .. include_body
 
 .. include:: ../man3/MPI_Aint_add.3.rst

diff --git a/docs/man-openmpi/man3/MPI_Allgather.3.rst b/docs/man-openmpi/man3/MPI_Allgather.3.rst
@@ -18,9 +18,9 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Allgather(const void *sendbuf, int  sendcount,
    	 MPI_Datatype sendtype, void *recvbuf, int recvcount,
    	 MPI_Datatype recvtype, MPI_Comm comm)
@@ -38,7 +38,6 @@ Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -65,7 +64,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Allgather(sendbuf, sendcount, sendtype, recvbuf, recvcount, recvtype,
@@ -212,6 +210,6 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    | :ref:`MPI_Allgatherv`
    | :ref:`MPI_Gather`
diff --git a/docs/man-openmpi/man3/MPI_Allgather_init.3.rst b/docs/man-openmpi/man3/MPI_Allgather_init.3.rst
@@ -1,8 +1,7 @@
 .. _mpi_allgather_init:
-
+ 
 MPI_Allgather_init
 ==================
-
     .. include_body
 
 .. include:: ../man3/MPI_Allgather.3.rst

diff --git a/docs/man-openmpi/man3/MPI_Allgatherv.3.rst b/docs/man-openmpi/man3/MPI_Allgatherv.3.rst
@@ -19,9 +19,9 @@ C Syntax
 ^^^^^^^^
 
 .. code-block:: c
-   :linenos:
 
    #include <mpi.h>
+
    int MPI_Allgatherv(const void *sendbuf, int sendcount,
    	MPI_Datatype sendtype, void *recvbuf, const int recvcounts[],
    	const int displs[], MPI_Datatype recvtype, MPI_Comm comm)
@@ -41,7 +41,6 @@ Fortran Syntax
 ^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE MPI
    ! or the older form: INCLUDE 'mpif.h'
@@ -68,7 +67,6 @@ Fortran 2008 Syntax
 ^^^^^^^^^^^^^^^^^^^
 
 .. code-block:: fortran
-   :linenos:
 
    USE mpi_f08
    MPI_Allgatherv(sendbuf, sendcount, sendtype, recvbuf, recvcounts, displs,
@@ -199,6 +197,6 @@ may be used to cause error values to be returned. Note that MPI does not
 guarantee that an MPI program can continue past an error.
 
 
-.. seealso:: 
+.. seealso::
    | :ref:`MPI_Gatherv`
    | :ref:`MPI_Allgather`
diff --git a/docs/man-openmpi/man3/MPI_Allgatherv_init.3.rst b/docs/man-openmpi/man3/MPI_Allgatherv_init.3.rst
@@ -1,8 +1,7 @@
 .. _mpi_allgatherv_init:
-
+ 
 MPI_Allgatherv_init
 ===================
-
     .. include_body
 
 .. include:: ../man3/MPI_Allgatherv.3.rst