Merge pull request #11077 from drwootton/man_headings

Change top level heading in man pages to upper case for consistency in Open MPI man pages.

Author: jjhursey

docs/man-openmpi/man3/MPIX_Query_cuda_support.3.rst

@@ -65,7 +65,7 @@ application with older versions of Open MPI or other MPI
 implementations that do not have this function.
 
 
-Examples
+EXAMPLES
 ^^^^^^^^
 
 .. code-block:: c

docs/man-openmpi/man3/MPIX_Query_rocm_support.3.rst

@@ -65,7 +65,7 @@ application with older versions of Open MPI or other MPI
 implementations that do not have this function.
 
 
-Examples
+EXAMPLES
 ^^^^^^^^
 
 .. code-block:: c

docs/man-openmpi/man3/MPI_Barrier.3.rst

@@ -8,7 +8,7 @@ MPI_Barrier
 :ref:`MPI_Barrier`, :ref:`MPI_Ibarrier` - Synchronization between MPI processes in a
 group
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -55,19 +55,19 @@ Fortran 2008 Syntax
        TYPE(MPI_Request), INTENT (OUT) :: request
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameter
+INPUT PARAMETER
 ---------------
 
 -  comm : Communicator (handle).
 -  info : Info (handle, persistent only).
 
-Output Parameters
+OUTPUT PARAMETERS
 -----------------
 
 -  request : Request (handle, non-blocking only).
 -  IERROR : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 An MPI barrier completes after all groups members have entered the
@@ -81,7 +81,7 @@ performed across all processes in both groups. All processes in the
 first group may exit the barrier when all processes in the second group
 have entered the barrier.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Bsend.3.rst

@@ -7,7 +7,7 @@ MPI_Bsend
 
 :ref:`MPI_Bsend` - Basic send with user-specified buffering.
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -45,7 +45,7 @@ Fortran 2008 Syntax
        TYPE(MPI_Comm), INTENT(IN) :: comm
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameters
+INPUT PARAMETERS
 ----------------
 
 -  ``buf`` : Initial address of send buffer (choice).
@@ -55,17 +55,17 @@ Input Parameters
 -  ``tag`` : Message tag (integer).
 -  ``comm`` : Communicator (handle).
 
-Output Parameters
+OUTPUT PARAMETERS
 -----------------
 
 -  ``IERROR`` : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 :ref:`MPI_Bsend` performs a buffered-mode, blocking send.
 
-Notes
+NOTES
 -----
 
 This send is provided as a convenience function; it allows the user to
@@ -94,7 +94,7 @@ In C, you can force the messages to be delivered by
 ``MPI_Buffer_detach`` will not complete until all buffered messages are
 delivered.)
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Bsend_init.3.rst

@@ -7,7 +7,7 @@ MPI_Bsend_init
 
 :ref:`MPI_Bsend_init` - Builds a handle for a buffered send.
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -48,7 +48,7 @@ Fortran 2008 Syntax
        TYPE(MPI_Request), INTENT(OUT) :: request
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameters
+INPUT PARAMETERS
 ----------------
 
 -  buf : Initial address of send buffer (choice).
@@ -58,13 +58,13 @@ Input Parameters
 -  tag : Message tag (integer).
 -  comm : Communicator (handle).
 
-Output Parameters
+OUTPUT PARAMETERS
 -----------------
 
 -  request : Communication request (handle).
 -  IERROR : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 Creates a persistent communication request for a buffered mode send, and
@@ -73,7 +73,7 @@ binds to it all the arguments of a send operation.
 A communication (send or receive) that uses a persistent request is
 initiated by the function :ref:`MPI_Start`.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Buffer_attach.3.rst

@@ -7,7 +7,7 @@ MPI_Buffer_attach
 
 :ref:`MPI_Buffer_attach` - Attaches a user-defined buffer for sending.
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -43,25 +43,25 @@ Fortran 2008 Syntax
        INTEGER, INTENT(IN) :: size
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameters
+INPUT PARAMETERS
 ----------------
 
 -  buf : Initial buffer address (choice).
 -  size : Buffer size, in bytes (integer).
 
-Output Parameter
+OUTPUT PARAMETER
 ----------------
 
 -  IERROR : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 Provides to MPI a buffer in the user's memory to be used for buffering
 outgoing messages. The buffer is used only by messages sent in buffered
 mode. Only one buffer can be attached to a process at a time.
 
-Notes
+NOTES
 -----
 
 The size given should be the sum of the sizes of all outstanding Bsends
@@ -83,7 +83,7 @@ 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
 Fortran.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Buffer_detach.3.rst

@@ -8,7 +8,7 @@ MPI_Buffer_detach
 :ref:`MPI_Buffer_detach` - Removes an existing buffer (for use in in :ref:`MPI_Bsend`,
 etc.)
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -45,14 +45,14 @@ Fortran 2008 Syntax
        INTEGER, INTENT(OUT) :: size
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Output Parameters
+OUTPUT PARAMETERS
 -----------------
 
 -  buf : Initial buffer address (choice).
 -  size : Buffer size, in bytes (integer).
 -  IERROR : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 Detach the buffer currently associated with MPI. The call returns the
@@ -69,7 +69,7 @@ MPI_Buffer_detach( &buff, &size); /* Buffer size reduced to zero */
 MPI_Buffer_attach( buff, size); /* Buffer of 10000 bytes available again
 \*/
 
-Notes
+NOTES
 -----
 
 The reason that :ref:`MPI_Buffer_detach` returns the address and size of the
@@ -97,7 +97,7 @@ differently: A pointer to the buffer is passed to :ref:`MPI_Buffer_attach`; the
 address of the pointer is passed to :ref:`MPI_Buffer_detach`, so that this call
 can return the pointer value.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Cancel.3.rst

@@ -7,7 +7,7 @@ MPI_Cancel
 
 :ref:`MPI_Cancel` - Cancels a communication request.
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -41,17 +41,17 @@ Fortran 2008 Syntax
        TYPE(MPI_Request), INTENT(IN) :: request
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameter
+INPUT PARAMETER
 ---------------
 
 -  request : Communication request (handle).
 
-Output Parameter
+OUTPUT PARAMETER
 ----------------
 
 -  IERROR : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 The :ref:`MPI_Cancel` operation allows pending communications to be canceled.
@@ -99,15 +99,15 @@ If the operation has been canceled, then information to that effect will
 be returned in the status argument of the operation that completes the
 communication.
 
-Notes
+NOTES
 -----
 
 The primary expected use of :ref:`MPI_Cancel` is in multi-buffering schemes,
 where speculative MPI_Irecvs are made. When the computation completes,
 some of these requests may remain; using :ref:`MPI_Cancel` allows the user to
 cancel these unsatisfied requests.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Cart_coords.3.rst

@@ -8,7 +8,7 @@ MPI_Cart_coords
 :ref:`MPI_Cart_coords` - Determines process coords in Cartesian topology
 given rank in group.
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -45,29 +45,29 @@ Fortran 2008 Syntax
        INTEGER, INTENT(OUT) :: coords(maxdims)
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameters
+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
    (integer). Length of vector coords in the calling program (integer).
 
-Output Parameters
+OUTPUT PARAMETERS
 -----------------
 
 -  ``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).
 
-Description
+DESCRIPTION
 -----------
 
 :ref:`MPI_Cart_coords` provides a mapping of ``rank``\ s to Cartesian
 coordinates.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst

docs/man-openmpi/man3/MPI_Cart_create.3.rst

@@ -8,7 +8,7 @@ MPI_Cart_create
 :ref:`MPI_Cart_create` - Makes a new communicator to which Cartesian
 topology information has been attached.
 
-Syntax
+SYNTAX
 ------
 
 C Syntax
@@ -49,7 +49,7 @@ Fortran 2008 Syntax
        TYPE(MPI_Comm), INTENT(OUT) :: comm_cart
        INTEGER, OPTIONAL, INTENT(OUT) :: ierror
 
-Input Parameters
+INPUT PARAMETERS
 ----------------
 
 -  ``comm_old`` : Input communicator (handle).
@@ -61,13 +61,13 @@ Input Parameters
 -  ``reorder`` : Ranking may be reordered (true) or not (false)
    (logical).
 
-Output Parameters
+OUTPUT PARAMETERS
 -----------------
 
 -  ``comm_cart`` : Communicator with new Cartesian topology (handle).
 -  ``IERROR`` : Fortran only: Error status (integer).
 
-Description
+DESCRIPTION
 -----------
 
 :ref:`MPI_Cart_create` returns a handle to a new communicator to which the
@@ -80,7 +80,7 @@ smaller than the size of the group of comm, then some processes are
 returned MPI_COMM_NULL, in analogy to :ref:`MPI_Comm_split`. The call
 is erroneous if it specifies a grid that is larger than the group size.
 
-Errors
+ERRORS
 ------
 
 .. include:: ./ERRORS.rst