doc: lots of improvements to code-blocks and variables

Basically all files have had a go to be updated
and beautified, too many to list here.

Signed-off-by: Nick Papior <nickpapior@gmail.com>

Author: zerothi

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

@@ -75,9 +75,9 @@ that originally produced *base* had called:
 
 ::
 
-           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,7 +86,7 @@ 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`.
 
 

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

@@ -126,7 +126,7 @@ 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
 
 ::
@@ -169,7 +169,7 @@ identical to the case in which all processes executed *n* calls to
 
 ::
 
-      MPI_ALLGATHER ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf,
+      MPI_Allgather( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf,
       recvcount, recvtype, root, comm )
 
    for root =0, ... , n-1.

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

@@ -152,12 +152,12 @@ 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
 
 ::
 
-      MPI_ALLGATHERV ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf,
+      MPI_Allgatherv ( MPI_IN_PLACE, 0, MPI_DATATYPE_NULL, recvbuf,
       recvcounts, displs, recvtype, root, comm )
 
    for root =0, ... , n-1.

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

@@ -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

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

@@ -48,7 +48,7 @@ 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).

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

@@ -14,18 +14,18 @@ SYNTAX
 C Syntax
 ^^^^^^^^
 
-.. code:: C
+.. code-block:: C
 
    #include <mpi.h>
 
    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`

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

@@ -14,7 +14,7 @@ SYNTAX
 C Syntax
 ^^^^^^^^
 
-.. code:: C
+.. code-block:: C
 
    #include <mpi.h>
 
@@ -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];

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

@@ -13,7 +13,7 @@ SYNTAX
 C Syntax
 ^^^^^^^^
 
-.. code:: c
+.. code-block:: c
 
    #include <mpi.h>
 
@@ -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<m; i++) {

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

@@ -13,7 +13,7 @@ SYNTAX
 C Syntax
 ^^^^^^^^
 
-.. code:: C
+.. code-block:: C
 
    #include <mpi.h>
 
@@ -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
 -----------