Skip to content

Commit ffa33de

Browse files
committed
docs: a few more miscellaneous RST format updates
Just putting some text in fixed-width font, etc. No text or content changes. Signed-off-by: Jeff Squyres <jeff@squyres.com>
1 parent 5da4cfd commit ffa33de

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,13 +75,13 @@ deprecated. The C binding is identical. The Fortran binding differs in
7575
that ``extra_state`` is an address-sized integer. Also, the copy and
7676
delete callback functions have Fortran bindings that are consistent with
7777
address-sized attributes. The argument ``comm_copy_attr_fn`` may be
78-
specified as MPI_COMM_NULL_COPY_FN or MPI_COMM_DUP_FN from C or
79-
Fortran. MPI_COMM_NULL_COPY_FN is a function that does nothing more
80-
than returning ``flag = 0`` and MPI_SUCCESS. MPI_COMM_DUP_FN is
78+
specified as ``MPI_COMM_NULL_COPY_FN`` or ``MPI_COMM_DUP_FN`` from C or
79+
Fortran. ``MPI_COMM_NULL_COPY_FN`` is a function that does nothing more
80+
than returning ``flag = 0`` and ``MPI_SUCCESS``. ``MPI_COMM_DUP_FN`` is
8181
a simple-minded copy function that sets ``flag = 1``, returns the value
8282
of ``attribute_val_in`` in ``attribute_val_out``, and returns
83-
MPI_SUCCESS. These replace the MPI-1 predefined callbacks
84-
MPI_NULL_COPY_FN and MPI_DUP_FN, the use of which is deprecated.
83+
``MPI_SUCCESS``. These replace the MPI-1 predefined callbacks
84+
``MPI_NULL_COPY_FN`` and ``MPI_DUP_FN``, the use of which is deprecated.
8585
The two C callback functions are:
8686

8787
.. code-block:: c

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ The `MPI Standard <https://www.mpi-forum.org/docs/>`_ states that an
8282
implementation may make the output
8383
value (errhandler) simply the address of the function. However, the
8484
action of :ref:`MPI_Errhandler_free` makes this impossible, since it is
85-
required to set the value of the argument to MPI_ERRHANDLER_NULL. In
85+
required to set the value of the argument to ``MPI_ERRHANDLER_NULL``. In
8686
addition, the actual error handler must remain until all communicators
8787
that use it are freed.
8888

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ provided by the receive call that set the status variable. As explained
6565
in the "Use of General Datatypes in Communication" section of the `MPI
6666
Standard <https://www.mpi-forum.org/docs/>`_.
6767
:ref:`MPI_Get_count` may, in certain situations, return the value
68-
MPI_UNDEFINED.
68+
``MPI_UNDEFINED``.
6969

7070
The datatype argument is passed to :ref:`MPI_Get_count` to improve performance.
7171
A message might be received without counting the number of elements it
@@ -78,14 +78,14 @@ NOTES
7878
If the size of the datatype is zero, this routine will return a count of
7979
zero. If the amount of data in status is not an exact multiple of the
8080
size of datatype (so that count would not be integral), a count of
81-
MPI_UNDEFINED is returned instead.
81+
``MPI_UNDEFINED`` is returned instead.
8282

8383
ERRORS
8484
------
8585

8686
.. include:: ./ERRORS.rst
8787

8888
If the value to be returned is larger than can fit into the count
89-
parameter, an MPI_ERR_TRUNCATE error is raised.
89+
parameter, an ``MPI_ERR_TRUNCATE`` error is raised.
9090

9191
.. seealso:: :ref:`MPI_Get_elements`

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -107,15 +107,15 @@ of attributes of returned data types is undefined.
107107
Note that :ref:`MPI_Type_get_contents` can be invoked with a data-type argument
108108
that was constructed using :ref:`MPI_Type_create_f90_real`,
109109
:ref:`MPI_Type_create_f90_integer`, or :ref:`MPI_Type_create_f90_complex` (an unnamed
110-
predefined data type). In such a case, an empty *array_of_datatypes is
111-
returned.*
110+
predefined data type). In such a case, an empty *array_of_datatypes* is
111+
returned.
112112

113113
In the legacy MPI-1 datatype constructor calls, the address arguments in
114114
Fortran are of type ``INTEGER``. In subsequent versions of the `MPI
115115
Standard <https://www.mpi-forum.org/docs/>`_, the address
116116
arguments are of type ``INTEGER(KIND=MPI_ADDRESS_KIND)``. The call
117117
:ref:`MPI_Type_get_contents` returns all addresses in an argument of type
118-
INTEGER(KIND=MPI_ADDRESS_KIND). This is true even if the old MPI-1 calls
118+
``INTEGER(KIND=MPI_ADDRESS_KIND)``. This is true even if the old MPI-1 calls
119119
were used. Thus, the location of values returned can be thought of as
120120
being returned by the C bindings. It can also be determined by examining
121121
the new MPI-2 calls for data-type constructors for the deprecated MPI-1

0 commit comments

Comments
 (0)