docs: miscellaneous RST format fixes

jsquyres · jsquyres · commit 740ab1a5779b · 2023-11-13T15:51:05.000-05:00
No actual verbiage changes or content changes; just fixing a bunch of RST minor errors (e.g., things that should have been in fixed-width font that weren't). Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 811ffef)
diff --git a/docs/man-openmpi/man3/MPI_File_iread.3.rst b/docs/man-openmpi/man3/MPI_File_iread.3.rst
@@ -78,7 +78,7 @@ pointer position maintained by the system in which a total number of
 buffer *buf.* The data is taken out of those parts of the file specified
 by the current view. :ref:`MPI_File_iread` stores the number of data-type
 elements actually read in *status.* All other fields of *status* are
-undefined. It is erroneous to call this function if MPI_MODE_SEQUENTIAL
+undefined. It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL``
 mode was specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_iread_all.3.rst b/docs/man-openmpi/man3/MPI_File_iread_all.3.rst
@@ -79,7 +79,7 @@ the user's buffer *buf.* The data is taken out of those parts of the
 file specified by the current view. :ref:`MPI_File_iread_all` stores the number
 of data-type elements actually read in *status.* All other fields of
 *status* are undefined. It is erroneous to call this function if
-MPI_MODE_SEQUENTIAL mode was specified when the file was opened.
+``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened.
 
 
 ERRORS
diff --git a/docs/man-openmpi/man3/MPI_File_iwrite.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite.3.rst
@@ -80,7 +80,7 @@ specified by the current view. :ref:`MPI_File_iwrite` stores the number of
 *datatype* elements actually written in *status.* All other fields of
 *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was open.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_all.3.rst
@@ -80,7 +80,7 @@ specified by the current view. :ref:`MPI_File_iwrite_all` stores the number of
 *datatype* elements actually written in *status.* All other fields of
 *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was open.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_at.3.rst
@@ -85,7 +85,7 @@ elements actually written in *status.* All other fields of *status* are
 undefined. The request structure can be passed to :ref:`MPI_Wait` or :ref:`MPI_Test`,
 which will return a status with the number of bytes actually accessed.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was open.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_iwrite_at_all.3.rst
@@ -86,7 +86,7 @@ other fields of *status* are undefined. The request structure can be
 passed to :ref:`MPI_Wait` or :ref:`MPI_Test`, which will return a status with the
 number of bytes actually accessed.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was open.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_preallocate.3.rst b/docs/man-openmpi/man3/MPI_File_preallocate.3.rst
@@ -78,7 +78,7 @@ file size is unchanged.
 
 The treatment of file pointers, pending nonblocking accesses, and file
 consistency is the same as with :ref:`MPI_File_set_size`. If
-MPI_MODE_SEQUENTIAL mode was specified when the file was opened, it is
+``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened, it is
 erroneous to call this routine.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_read.3.rst b/docs/man-openmpi/man3/MPI_File_read.3.rst
@@ -77,7 +77,7 @@ specified by the current view. :ref:`MPI_File_read` stores the number of
 data-type elements actually read in *status.* All other fields of
 *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_all.3.rst b/docs/man-openmpi/man3/MPI_File_read_all.3.rst
@@ -77,7 +77,7 @@ out of those parts of the file specified by the current view.
 :ref:`MPI_File_read_all` stores the number of data-type elements actually read
 in *status.* All other fields of *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_all_begin.3.rst
@@ -82,7 +82,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_all_end.3.rst
@@ -77,7 +77,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_at.3.rst b/docs/man-openmpi/man3/MPI_File_read_at.3.rst
@@ -81,7 +81,7 @@ locating an offset. The data is taken out of those parts of the file
 specified by the current view. :ref:`MPI_File_read_at` stores the number of
 *datatype* elements actually read in *status.* All other fields of
 *status* are undefined. It is erroneous to call this function if
-MPI_MODE_SEQUENTIAL mode was specified when the file was opened.
+``MPI_MODE_SEQUENTIAL`` mode was specified when the file was opened.
 
 
 ERRORS
diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all.3.rst
@@ -81,7 +81,7 @@ is, holes are not counted when locating an offset. The data is taken out
 of those parts of the file specified by the current view.
 :ref:`MPI_File_read_at_all` stores the number of *datatype* elements actually
 read in *status.* All other fields of *status* are undefined. It is
-erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_at_all_end.3.rst
@@ -76,7 +76,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered_begin.3.rst
@@ -86,7 +86,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst b/docs/man-openmpi/man3/MPI_File_read_ordered_end.3.rst
@@ -81,7 +81,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_set_size.3.rst b/docs/man-openmpi/man3/MPI_File_set_size.3.rst
@@ -77,7 +77,7 @@ shared file pointer.
 Note that the actual amount of storage space cannot be allocated by
 :ref:`MPI_File_set_size`. Use :ref:`MPI_File_preallocate` to accomplish this.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_write.3.rst b/docs/man-openmpi/man3/MPI_File_write.3.rst
@@ -81,7 +81,7 @@ specified by the current view. :ref:`MPI_File_write` stores the number of
 *datatype* elements actually written in *status.* All other fields of
 *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_all.3.rst b/docs/man-openmpi/man3/MPI_File_write_all.3.rst
@@ -77,7 +77,7 @@ into those parts of the file specified by the current view.
 :ref:`MPI_File_write_all` stores the number of *datatype* elements actually
 written in *status.* All other fields of *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_all_begin.3.rst
@@ -82,7 +82,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_all_end.3.rst
@@ -80,7 +80,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_at.3.rst b/docs/man-openmpi/man3/MPI_File_write_at.3.rst
@@ -81,7 +81,7 @@ specified by the current view. :ref:`MPI_File_write_at` stores the number of
 *datatype* elements actually written in *status.* All other fields of
 *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all.3.rst
@@ -81,7 +81,7 @@ written into those parts of the file specified by the current view.
 :ref:`MPI_File_write_at_all` stores the number of *datatype* elements actually
 written in *status.* All other fields of *status* are undefined.
 
-It is erroneous to call this function if MPI_MODE_SEQUENTIAL mode was
+It is erroneous to call this function if ``MPI_MODE_SEQUENTIAL`` mode was
 specified when the file was opened.
 
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all_begin.3.rst
@@ -85,7 +85,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_at_all_end.3.rst
@@ -78,7 +78,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered_begin.3.rst
@@ -85,7 +85,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst b/docs/man-openmpi/man3/MPI_File_write_ordered_end.3.rst
@@ -76,7 +76,7 @@ NOTES
 -----
 
 All the nonblocking collective routines for data access are "split" into
-two routines, each with \_begin or \_end as a suffix. These split
+two routines, each with ``_begin`` or ``_end`` as a suffix. These split
 collective routines are subject to the semantic rules described in
 Section 9.4.5 of the MPI-2 standard.
 
diff --git a/docs/man-openmpi/man3/MPI_Grequest_start.3.rst b/docs/man-openmpi/man3/MPI_Grequest_start.3.rst
@@ -188,12 +188,12 @@ then the error code returned by the callback function will be returned
 by the MPI function that invoked the callback function. In the case of a
 ``MPI_{Wait|Test}any`` call that invokes both ``query_fn`` and
 ``free_fn``, the MPI call will return the error code returned by the
-last callback, namely ``free_fn``. If one or more of the ``request``\ s
+last callback, namely ``free_fn``. If one or more of the ``request``s
 in a call to ``MPI_{Wait|Test}{some|all``} has failed, then the MPI call
-will return MPI_ERR_IN_STATUS. In such a case, if the MPI call was
+will return ``MPI_ERR_IN_STATUS``. In such a case, if the MPI call was
 passed an array of statuses, then MPI will return in each of the
 statuses that correspond to a completed generalized ``request`` the
 error code returned by the corresponding invocation of its ``free_fn``
 callback function. However, if the MPI function was passed
-MPI_STATUSES_IGNORE, then the individual error codes returned by
+``MPI_STATUSES_IGNORE``, then the individual error codes returned by
 each callback function will be lost.
diff --git a/docs/man-openmpi/man3/MPI_Improbe.3.rst b/docs/man-openmpi/man3/MPI_Improbe.3.rst
@@ -79,7 +79,7 @@ receive buffer according to the length of the probed message.
 
 A matching probe with ``MPI_PROC_NULL`` as *source* returns *flag* = true,
 
-*message* =`` MPI_MESSAGE_NO_PROC``, and the *status* object returns source
+*message* = ``MPI_MESSAGE_NO_PROC``, and the *status* object returns source
 ^ ``MPI_PROC_NULL``, tag ^ ``MPI_ANY_TAG``, and count ^ 0.
 
 :ref:`MPI_Iprobe` returns a true value in *flag* if a message has been matched
diff --git a/docs/man-openmpi/man3/MPI_Imrecv.3.rst b/docs/man-openmpi/man3/MPI_Imrecv.3.rst
@@ -72,7 +72,7 @@ previously matched by a matching probe.
 The *request* returned from :ref:`MPI_Imrecv` can be used with any of the
 :ref:`MPI_Test` and :ref:`MPI_Wait` variants, like any non-blocking receive request.
 
-If :ref:`MPI_Imrecv` is called with MPI_MESSAGE_NULL as the message argument, a
+If :ref:`MPI_Imrecv` is called with ``MPI_MESSAGE_NULL`` as the message argument, a
 call to one of the :ref:`MPI_Test` or :ref:`MPI_Wait` variants will return immediately
 with the *status* object set to *source* = ``MPI_PROC_NULL``, *tag* =
 ``MPI_ANY_TAG``, and *count* = 0, as if a receive from ``MPI_PROC_NULL`` was
@@ -81,14 +81,14 @@ issued.
 If reception of a matched message is started with :ref:`MPI_Imrecv`, then it is
 possible to cancel the returned request with :ref:`MPI_Cancel`. If :ref:`MPI_Cancel`
 succeeds, the matched message must be found by a subsequent message
-probe (:ref:`MPI_Probe`, :ref:`MPI_Iprobe`, :ref:`MPI_Mprobe`, or MPI_Improbe), received by a
+probe (:ref:`MPI_Probe`, :ref:`MPI_Iprobe`, :ref:`MPI_Mprobe`, or :ref:`MPI_Improbe`), received by a
 subsequent receive operation or canceled by the sender.
 
 Note, however, that is it possible for the cancellation of operations
 initiated with :ref:`MPI_Imrecv` to fail. An example of a failing case is when
 canceling the matched message receive would violate MPI message ordering
 rules (e.g., if another message matching the same message signature has
-matched -- and possible received -- before this :ref:`MPI_Imrecv` is canceled).
+matched |mdash| and possibly received |mdash| before this :ref:`MPI_Imrecv` is canceled).
 
 
 ERRORS
diff --git a/docs/man-openmpi/man3/MPI_Iprobe.3.rst b/docs/man-openmpi/man3/MPI_Iprobe.3.rst
@@ -72,16 +72,16 @@ the information returned by status). In particular, the user may
 allocate memory for the receive buffer, according to the length of the
 probed message.
 
-``MPI_Iprobe(source, tag, comm, flag, status)`` returns flag = true if there
+``MPI_Iprobe(source, tag, comm, flag, status)`` returns *flag* = true if there
 is a message that can be received and that matches the pattern specified
 by the arguments source, tag, and comm. The call matches the same
 message that would have been received by a call to ``MPI_Recv(..., source,
 tag, comm, status)`` executed at the same point in the program, and
 returns in status the same value that would have been returned by
-:ref:`MPI_Recv`. Otherwise, the call returns flag = false, and leaves status
+:ref:`MPI_Recv`. Otherwise, the call returns *flag* = false, and leaves status
 undefined.
 
-If :ref:`MPI_Iprobe` returns flag = true, then the content of the status object
+If :ref:`MPI_Iprobe` returns *flag* = true, then the content of the status object
 can be subsequently accessed as described in Section 3.2.5 of the MPI-1
 Standard, "Return Status," to find the source, tag, and length of the
 probed message.
diff --git a/docs/man-openmpi/man3/MPI_Mrecv.3.rst b/docs/man-openmpi/man3/MPI_Mrecv.3.rst
@@ -70,7 +70,7 @@ DESCRIPTION
 The functions :ref:`MPI_Mrecv` and :ref:`MPI_Imrecv` receive messages that have been
 previously matched by a matching probe.
 
-If :ref:`MPI_Mrecv` is called with MPI_MESSAGE_NULL as the message argument,
+If :ref:`MPI_Mrecv` is called with ``MPI_MESSAGE_NULL`` as the message argument,
 the call returns immediately with the *status* object set to *source* =
 ``MPI_PROC_NULL``, *tag* = ``MPI_ANY_TAG``, and *count* = 0, as if a receive
 from ``MPI_PROC_NULL`` was issued.
diff --git a/docs/man-openmpi/man3/MPI_Probe.3.rst b/docs/man-openmpi/man3/MPI_Probe.3.rst
@@ -81,7 +81,7 @@ will return, unless the message is received by another concurrent
 receive operation (that is executed by another thread at the probing
 process). Similarly, if a process busy waits with :ref:`MPI_Iprobe` and a
 matching message has been issued, then the call to :ref:`MPI_Iprobe` will
-eventually return flag = true unless the message is received by another
+eventually return *flag* = true unless the message is received by another
 concurrent receive operation.
 
 **Example 1:** Use blocking probe to wait for an incoming message.
