Skip to content

Commit 8ea416c

Browse files
zerothijsquyres
authored andcommitted
doc: codefied lots of constants and other minor references
Signed-off-by: Nick Papior <nickpapior@gmail.com>
1 parent 92049e6 commit 8ea416c

File tree

80 files changed

+165
-165
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+165
-165
lines changed

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ non-portable syntax
149149
150150
INTEGER*MPI_ADDRESS_KIND TARGET_DISP
151151
152-
where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the
152+
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
153153
length of the declared integer in bytes.
154154

155155

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ symmetric, full-duplex behavior.
158158

159159
The first group defines the root process. The root process uses MPI_ROOT
160160
as the value of *root*. All other processes in the first group use
161-
MPI_PROC_NULL as the value of *root*. All processes in the second group
161+
``MPI_PROC_NULL`` as the value of *root*. All processes in the second group
162162
use the rank of the root process in the first group as the value of
163163
*root*.
164164

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ symmetric, full-duplex behavior.
177177

178178
The first group defines the root process. The root process uses MPI_ROOT
179179
as the value of *root*. All other processes in the first group use
180-
MPI_PROC_NULL as the value of *root*. All processes in the second group
180+
``MPI_PROC_NULL`` as the value of *root*. All processes in the second group
181181
use the rank of the root process in the first group as the value of
182182
*root*.
183183

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,7 @@ symmetric, full-duplex behavior.
181181

182182
The first group defines the root process. The root process uses MPI_ROOT
183183
as the value of *root*. All other processes in the first group use
184-
MPI_PROC_NULL as the value of *root*. All processes in the second group
184+
``MPI_PROC_NULL`` as the value of *root*. All processes in the second group
185185
use the rank of the root process in the first group as the value of
186186
*root*.
187187

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ When the communicator is an inter-communicator, the root process in the
114114
first group broadcasts data to all the processes in the second group.
115115
The first group defines the root process. That process uses MPI_ROOT
116116
as the value of its ``root`` argument. The remaining processes use
117-
MPI_PROC_NULL as the value of their ``root`` argument. All processes
117+
``MPI_PROC_NULL`` as the value of their ``root`` argument. All processes
118118
in the second group use the rank of that root process in the first group
119119
as the value of their ``root`` argument. The receive buffer arguments of
120120
the processes in the second group must be consistent with the send

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ n-dimensional Cartesian mesh.
8585
Depending on the periodicity of the Cartesian group in the specified
8686
coordinate ``direction``, :ref:`MPI_Cart_shift` provides the identifiers
8787
for a circular or an end-off shift. In the case of an end-off shift, the
88-
value MPI_PROC_NULL may be returned in ``rank_source`` or
88+
value ``MPI_PROC_NULL`` may be returned in ``rank_source`` or
8989
``rank_dest``, indicating that the source or the destination for the
9090
shift is out of range.
9191

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,7 @@ the non-portable syntax
123123
124124
INTEGER*MPI_ADDRESS_KIND EXTRA_STATE
125125
126-
where ``MPI_ADDRESS_KIND`` is a constant defined in mpif.h and gives the
126+
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
127127
length of the declared integer in bytes.
128128

129129
ERRORS

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ use the non-portable syntax
8787
8888
INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL
8989
90-
where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the
90+
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
9191
length of the declared integer in bytes.
9292

9393

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ use the non-portable syntax
8989
9090
INTEGER*MPI_ADDRESS_KIND ATTRIBUTE_VAL
9191
92-
where MPI_ADDRESS_KIND is a constant defined in mpif.h and gives the
92+
where ``MPI_ADDRESS_KIND`` is a constant defined in ``mpif.h`` and gives the
9393
length of the declared integer in bytes.
9494

9595

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,21 +58,21 @@ OUTPUT PARAMETERS
5858
DESCRIPTION
5959
-----------
6060

61-
:ref:`MPI_COMM_SET_INFO` sets new values for the hints of the communicator
62-
associated with *comm*. :ref:`MPI_COMM_SET_INFO` is a collective routine. The
61+
:ref:`MPI_Comm_set_info` sets new values for the hints of the communicator
62+
associated with *comm*. :ref:`MPI_Comm_set_info` is a collective routine. The
6363
info object may be different on each process, but any info entries that
6464
an implementation requires to be the same on all processes must appear
6565
with the same value in each process's *info* object.
6666

6767
The following info key assertions may be accepted by Open MPI:
6868

6969
*mpi_assert_no_any_tag* (boolean): If set to true, then the
70-
implementation may assume that the process will not use the MPI_ANY_TAG
70+
implementation may assume that the process will not use the ``MPI_ANY_TAG``
7171
wildcard on the given communicator.
7272

7373
*mpi_assert_no_any_source* (boolean): If set to true, then the
7474
implementation may assume that the process will not use the
75-
MPI_ANY_SOURCE wildcard on the given communicator.
75+
``MPI_ANY_SOURCE`` wildcard on the given communicator.
7676

7777
*mpi_assert_exact_length* (boolean): If set to true, then the
7878
implementation may assume that the lengths of messages received by the

0 commit comments

Comments
 (0)