open-mpi · janjust · Nov 16, 2023 · Nov 11, 2023 · Nov 11, 2023 · Nov 11, 2023
diff --git a/docs/building-apps/abi-compatibility.rst b/docs/building-apps/abi-compatibility.rst
@@ -8,7 +8,7 @@ compatibility for the C MPI bindings to the last major Open MPI release. Specifi
 application compiled with Open MPI v4.x can be executed with Open MPI
 |ompi_series| without having to recompile the application.
 
-.. important:: ABI is maintained for *most* of the Fortran MPI bindings, too -- see below for additional information.
+.. important:: ABI is maintained for *most* of the Fortran MPI bindings, too |mdash| see below for additional information.
 
 There are however a few scenarios where an application compiled with
 Open MPI v4.x might not execute correctly with Open MPI 5.0.

diff --git a/docs/developers/prerequisites.rst b/docs/developers/prerequisites.rst
@@ -96,8 +96,8 @@ generate both the HTML version of the documentation (that you are
 reading right now) and the nroff man pages.
 
 Official Open MPI distribution tarballs contain pre-built HTML
-documentation and man pages.  This means that -- similar to the GNU
-Autotools -- end users do not need to have Sphinx installed, but will
+documentation and man pages.  This means that |mdash| similar to the GNU
+Autotools |mdash| end users do not need to have Sphinx installed, but will
 still have both the HTML documentation and man pages installed as part
 of the normal configure / build / install process.
 

diff --git a/docs/developers/rst-for-markdown-expats.rst b/docs/developers/rst-for-markdown-expats.rst
@@ -228,7 +228,7 @@ Comments
         will not be included in the rendered output.
 
         Your comment can even include blank lines.  You terminate a
-        comment -- just like most other things in RST -- by a blank
+        comment |mdash| just like most other things in RST |mdash| by a blank
         line and then outdenting back out to the same column as the
         first ".".
 

diff --git a/docs/developers/source-code.rst b/docs/developers/source-code.rst
@@ -54,7 +54,7 @@ C / C++
   * C99-style mixing declarations are allow allowable (and preferred).
 
 * **ALWAYS** include ``<level>_config.h`` as your first #include file,
-  where ``<level>`` is one of ``ompi``, ``oshmem``, or ``opal`` -- the
+  where ``<level>`` is one of ``ompi``, ``oshmem``, or ``opal`` |mdash| the
   level that you're writing in.  There are very, very few cases where
   this is not true (E.g., some bizarre Windows scenarios).  But in
   99.9999% of cases, this file should be included **first** so that it
@@ -77,7 +77,7 @@ C / C++
   * The GNU Way is to ``#define`` a macro when it is "true" and to
     ``#undef`` it when it is "false".
   * In Open MPI, we **always** ``#define`` a logical macro to be
-    either 0 or 1 -- we never ``#undef`` it.
+    either 0 or 1 |mdash| we never ``#undef`` it.
   * The reason for this is defensive programming: if you are only
     checking if a preprocessor macro is defined (via ``#ifdef FOO`` or
     ``#if defined(FOO)``), you will get no warning when compiling if

diff --git a/docs/features/java.rst b/docs/features/java.rst
@@ -6,7 +6,7 @@ Open MPI Java bindings
 Open MPI |ompi_ver| provides support for Java-based MPI applications.
 
 .. warning:: The Open MPI Java bindings are provided on a
-   "provisional" basis -- i.e., they are not part of the current or
+   "provisional" basis |mdash| i.e., they are not part of the current or
    proposed MPI standards.  Thus, inclusion of Java support is not
    required by the standard.  Continued inclusion of the Java bindings
    is contingent upon active user interest and continued developer

diff --git a/docs/features/ulfm.rst b/docs/features/ulfm.rst
@@ -573,7 +573,7 @@ sign up on the user's mailing list: ulfm+subscribe@googlegroups.com
 
 Because of spam, only subscribers are allowed to post to these lists
 (ensure that you subscribe with and post from exactly the same e-mail
-address -- joe@example.com is considered different than
+address |mdash| joe@example.com is considered different than
 joe@mycomputer.example.com!).  Visit these pages to subscribe to the
 lists: https://groups.google.com/forum/#!forum/ulfm
 

diff --git a/docs/history.rst b/docs/history.rst
@@ -20,13 +20,13 @@ MPI implementation focused on different areas of excellence, we all
 shared the same common core values:
 
 * A full MPI implementation
-* Production quality code -- it has to "just work"
+* Production quality code |mdash| it has to "just work"
 * A desire to explore lots of things that an MPI implementation can do
   that we've never had the time/resources to investigate because we
   are bound to bug fixing, etc.
 
 Hence, we decided to collaborate and pool our resources.  At SC2003,
-we decided to start an entire new code base -- leaving all the cruft
+we decided to start an entire new code base |mdash| leaving all the cruft
 and legacy code of our prior implementations behind.  Take the best,
 leave the rest.  The source tree's first commit was on November 22,
 2003; development work started in earnest on January 5, 2004.  Since

diff --git a/docs/installing-open-mpi/configure-cli-options/installation.rst b/docs/installing-open-mpi/configure-cli-options/installation.rst
@@ -238,7 +238,7 @@ be used with ``configure``:
   Some examples:
 
   #. Default to building all components as static (i.e., as part of
-     the Open MPI core libraries -- no DSOs)::
+     the Open MPI core libraries |mdash| no DSOs)::
 
         shell$ ./configure
 
@@ -304,7 +304,7 @@ be used with ``configure``:
   their Open MPI package, both of which require support libraries
   (``libFOO.so`` and ``libBAR.so``).  If an end user only has BAR
   hardware, they likely only have ``libBAR.so`` available on their
-  systems -- not ``libFOO.so``.  Disabling load errors by default will
+  systems |mdash| not ``libFOO.so``.  Disabling load errors by default will
   prevent the user from seeing potentially confusing warnings about
   the FOO components failing to load because ``libFOO.so`` is not
   available on their systems.

diff --git a/docs/installing-open-mpi/configure-cli-options/misc.rst b/docs/installing-open-mpi/configure-cli-options/misc.rst
@@ -29,7 +29,7 @@ above categories that can be used with ``configure``:
   with different endian representations).  Heterogeneous support is
   disabled by default because it imposes a minor performance penalty.
 
-  .. danger:: The heterogeneous functionality is currently broken --
+  .. danger:: The heterogeneous functionality is currently broken |mdash|
               do not use.
 
 .. _install-wrapper-flags-label:
@@ -40,7 +40,7 @@ above categories that can be used with ``configure``:
 * ``--with-wrapper-ldflags=LDFLAGS``
 * ``--with-wrapper-libs=LIBS``:
   Add the specified flags to the default flags that are used in Open
-  MPI's "wrapper" compilers (e.g., ``mpicc`` -- see below for more
+  MPI's "wrapper" compilers (e.g., ``mpicc`` |mdash| see below for more
   information about Open MPI's wrapper compilers).  By default, Open
   MPI's wrapper compilers use the same compilers used to build Open
   MPI and specify a minimum set of additional flags that are necessary

diff --git a/docs/installing-open-mpi/configure-cli-options/runtime.rst b/docs/installing-open-mpi/configure-cli-options/runtime.rst
@@ -13,7 +13,7 @@ can be used with ``configure``:
   prevents most ``rsh``/``ssh``-based users from needing to modify their
   shell startup files to set the ``PATH`` and/or ``LD_LIBRARY_PATH`` for
   Open MPI on remote nodes.  Note, however, that such users may still
-  desire to set ``PATH`` -- perhaps even in their shell startup files --
+  desire to set ``PATH`` |mdash| perhaps even in their shell startup files |mdash|
   so that executables such as ``mpicc`` and ``mpirun`` can be found
   without needing to type long path names.
 

diff --git a/docs/installing-open-mpi/required-support-libraries.rst b/docs/installing-open-mpi/required-support-libraries.rst
@@ -339,7 +339,7 @@ script deciding the following:
 * The Fortran compiler is ``gfortran`` (which is the
   Homebrew-installed Fortran compiler).
 * There is a suitable system-installed hwloc in ``/usr/local``, which
-  can be found -- by the C compiler/linker -- without specifying any
+  can be found |mdash| by the C compiler/linker |mdash| without specifying any
   additional linker search paths.
 
 The careful reader will realize that the C and Fortran compilers are
@@ -354,8 +354,8 @@ library search paths are different:
 Hence, since the majority of Open MPI's source code base is in C, it
 compiles/links against hwloc successfully.  But when Open MPI's
 Fortran code for the ``mpi_f08`` module is compiled and linked, the
-Homebrew-installed ``gfortran`` -- which does not search
-``/usr/local/lib`` by default -- cannot find ``libhwloc``, and the link
+Homebrew-installed ``gfortran`` |mdash| which does not search
+``/usr/local/lib`` by default |mdash| cannot find ``libhwloc``, and the link
 fails.
 
 There are a few different possible solutions to this issue:

diff --git a/docs/installing-open-mpi/supported-systems.rst b/docs/installing-open-mpi/supported-systems.rst
@@ -59,7 +59,7 @@ interconnects at the time of its release.
 This, unfortunately, does mean that Open MPI removes support for
 networks that are no longer commonly-used in HPC environments.  If you
 still have one of these older interconnects, not all new version of
-Open MPI may support your interconnect -- sorry!  This simply reflects
+Open MPI may support your interconnect |mdash| sorry!  This simply reflects
 the reality of limited development, testing, and maintenance
 resources.
 

diff --git a/docs/launching-apps/scheduling.rst b/docs/launching-apps/scheduling.rst
@@ -96,7 +96,7 @@ while there are still processes to be scheduled, Open MPI will trigger
 an oversubscription condition.
 
 If ``:OVERSUBSCRIBE`` is added as a modifier to the ``--map-by``
-option (e.g., ``mpirun --map-by node:OVERSUBSCRIBE ...`` -- :ref:`see
+option (e.g., ``mpirun --map-by node:OVERSUBSCRIBE ...`` |mdash| :ref:`see
 this section <running-mpi-apps-oversubscribing-label>` for more
 details), Open MPI will continue to loop through the list of nodes
 again and try to schedule one more process to each node until all

diff --git a/docs/launching-apps/troubleshooting.rst b/docs/launching-apps/troubleshooting.rst
@@ -22,7 +22,7 @@ why this can happen.
 
   .. code-block:: c
 
-     /* This is a Linux example -- the issue is similar/the same on other
+     /* This is a Linux example |mdash| the issue is similar/the same on other
         operating systems */
      handle = dlopen("libmpi.so", RTLD_NOW | RTLD_LOCAL);
 

diff --git a/docs/man-openmpi/man1/mpirun.1.rst b/docs/man-openmpi/man1/mpirun.1.rst
@@ -105,8 +105,8 @@ are slightly different than PRRTE's CLI commands.
 
 .. include:: /schizo-ompi-rst-content/schizo-ompi-cli.rstxt
 
-OPTIONS (OLD / HARD-CODED CONTENT -- TO BE AUDITED
---------------------------------------------------
+OPTIONS (OLD / HARD-CODED CONTENT |mdash| TO BE AUDITED
+-------------------------------------------------------
 
 .. admonition:: This is old content
    :class: error
@@ -1548,7 +1548,7 @@ variables.  The ``--mca`` settings similarly override MCA parameters
 set in the ``$OPAL_PREFIX/etc/openmpi-mca-params.conf`` or
 ``$HOME/.openmpi/mca-params.conf`` file.
 
-Unknown ``<key>`` arguments are still set as environment variable --
+Unknown ``<key>`` arguments are still set as environment variable |mdash|
 they are not checked (by mpirun) for correctness.  Illegal or
 incorrect ``<value>`` arguments may or may not be reported |mdash| it
 depends on the specific MCA module.

diff --git a/docs/man-openmpi/man1/ompi-wrapper-compiler.1.rst b/docs/man-openmpi/man1/ompi-wrapper-compiler.1.rst
@@ -137,7 +137,7 @@ link MPI applications that use any/all of the MPI Fortran bindings:
 Open MPI was installed with support for each of these Fortran
 bindings). Specifically: it is no longer necessary to use different
 wrapper compilers for applications that use ``mpif.h``
-vs. applications that use the ``mpi`` module -- just use ``mpifort``
+vs. applications that use the ``mpi`` module |mdash| just use ``mpifort``
 for all Fortran MPI applications.
 
 Note, however, that the Fortran compiler may require additional

diff --git a/docs/man-openmpi/man1/ompi_info.1.rst b/docs/man-openmpi/man1/ompi_info.1.rst
@@ -123,7 +123,7 @@ The three categories are:
    used to tweak MPI application performance. This even includes
    parameters that control resource exhaustion levels (e.g., number of
    free list entries, size of buffers, etc.), and could be considered
-   "correctness" parameters if they're set too low. But, really --
+   "correctness" parameters if they're set too low. But, really |mdash|
    they're tuning parameters.
 
 #. **Open MPI developer**: Parameters in this category either don't
@@ -133,7 +133,7 @@ The three categories are:
 And within each category, there are three sub-categories:
 
 #. **Basic**: This sub-category is for parameters that everyone in
-   this category will want to see -- even less-advanced end users,
+   this category will want to see |mdash| even less-advanced end users,
    application tuners, and new OMPI developers.
 
 #. **Detailed**: This sub-category is for parameters that are

diff --git a/docs/man-openmpi/man3/MPI_Abort.3.rst b/docs/man-openmpi/man3/MPI_Abort.3.rst
@@ -6,7 +6,7 @@ MPI_Abort
 
 .. include_body
 
-:ref:`MPI_Abort` - Terminates MPI execution environment.
+:ref:`MPI_Abort` |mdash| Terminates MPI execution environment.
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Add_error_class.3.rst b/docs/man-openmpi/man3/MPI_Add_error_class.3.rst
@@ -6,7 +6,7 @@ MPI_Add_error_class
 
 .. include_body
 
-:ref:`MPI_Add_error_class` - Creates a new error class and returns its value
+:ref:`MPI_Add_error_class` |mdash| Creates a new error class and returns its value
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Add_error_code.3.rst b/docs/man-openmpi/man3/MPI_Add_error_code.3.rst
@@ -6,7 +6,7 @@ MPI_Add_error_code
 
 .. include_body
 
-:ref:`MPI_Add_error_code` - Creates a new error code associated with
+:ref:`MPI_Add_error_code` |mdash| Creates a new error code associated with
 *errorclass*
 
 

diff --git a/docs/man-openmpi/man3/MPI_Add_error_string.3.rst b/docs/man-openmpi/man3/MPI_Add_error_string.3.rst
@@ -6,7 +6,7 @@ MPI_Add_error_string
 
 .. include_body
 
-:ref:`MPI_Add_error_string` - Associates a string with an error code or class
+:ref:`MPI_Add_error_string` |mdash| Associates a string with an error code or class
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Address.3.rst b/docs/man-openmpi/man3/MPI_Address.3.rst
@@ -6,7 +6,7 @@ MPI_Address
 
 .. include_body
 
-:ref:`MPI_Address` - Gets the address of a location in memory -- |deprecated_favor| :ref:`MPI_Get_address`.
+:ref:`MPI_Address` |mdash| Gets the address of a location in memory |mdash| |deprecated_favor| :ref:`MPI_Get_address`.
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst b/docs/man-openmpi/man3/MPI_Alloc_mem.3.rst
@@ -6,7 +6,7 @@ MPI_Alloc_mem
 
 .. include_body
 
-:ref:`MPI_Alloc_mem` - Allocates a specified memory segment.
+:ref:`MPI_Alloc_mem` |mdash| Allocates a specified memory segment.
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Attr_delete.3.rst b/docs/man-openmpi/man3/MPI_Attr_delete.3.rst
@@ -6,7 +6,7 @@ MPI_Attr_delete
 
 .. include_body
 
-:ref:`MPI_Attr_delete` - Deletes attribute value associated with a key -- |deprecated_favor| :ref:`MPI_Comm_delete_attr`.
+:ref:`MPI_Attr_delete` |mdash| Deletes attribute value associated with a key |mdash| |deprecated_favor| :ref:`MPI_Comm_delete_attr`.
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Attr_get.3.rst b/docs/man-openmpi/man3/MPI_Attr_get.3.rst
@@ -6,7 +6,7 @@ MPI_Attr_get
 
 .. include_body
 
-:ref:`MPI_Attr_get` - Retrieves attribute value by key -- |deprecated_favor| :ref:`MPI_Comm_get_attr`.
+:ref:`MPI_Attr_get` |mdash| Retrieves attribute value by key |mdash| |deprecated_favor| :ref:`MPI_Comm_get_attr`.
 
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Attr_put.3.rst b/docs/man-openmpi/man3/MPI_Attr_put.3.rst
@@ -6,7 +6,7 @@ MPI_Attr_put
 
 .. include_body
 
-:ref:`MPI_Attr_put` - Stores attribute value associated with a key -- |deprecated_favor| :ref:`MPI_Comm_set_attr`.
+:ref:`MPI_Attr_put` |mdash| Stores attribute value associated with a key |mdash| |deprecated_favor| :ref:`MPI_Comm_set_attr`.
 
 
 

diff --git a/docs/man-openmpi/man3/MPI_Bsend.3.rst b/docs/man-openmpi/man3/MPI_Bsend.3.rst
@@ -5,7 +5,7 @@ MPI_Bsend
 
 .. include_body
 
-:ref:`MPI_Bsend` - Basic send with user-specified buffering.
+:ref:`MPI_Bsend` |mdash| Basic send with user-specified buffering.
 
 SYNTAX
 ------

diff --git a/docs/man-openmpi/man3/MPI_Bsend_init.3.rst b/docs/man-openmpi/man3/MPI_Bsend_init.3.rst
@@ -5,7 +5,7 @@ MPI_Bsend_init
 
 .. include_body
 
-:ref:`MPI_Bsend_init` - Builds a handle for a buffered send.
+:ref:`MPI_Bsend_init` |mdash| Builds a handle for a buffered send.
 
 SYNTAX
 ------

diff --git a/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_attach.3.rst
@@ -5,7 +5,7 @@ MPI_Buffer_attach
 
 .. include_body
 
-:ref:`MPI_Buffer_attach` - Attaches a user-defined buffer for sending.
+:ref:`MPI_Buffer_attach` |mdash| Attaches a user-defined buffer for sending.
 
 SYNTAX
 ------

diff --git a/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst b/docs/man-openmpi/man3/MPI_Buffer_detach.3.rst
@@ -5,7 +5,7 @@ MPI_Buffer_detach
 
 .. include_body
 
-:ref:`MPI_Buffer_detach` - Removes an existing buffer (for use in in :ref:`MPI_Bsend`,
+:ref:`MPI_Buffer_detach` |mdash| Removes an existing buffer (for use in in :ref:`MPI_Bsend`,
 etc.)
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Cancel.3.rst b/docs/man-openmpi/man3/MPI_Cancel.3.rst
@@ -5,7 +5,7 @@ MPI_Cancel
 
 .. include_body
 
-:ref:`MPI_Cancel` - Cancels a communication request.
+:ref:`MPI_Cancel` |mdash| Cancels a communication request.
 
 SYNTAX
 ------
@@ -74,7 +74,7 @@ loop for a canceled communication, then :ref:`MPI_Test` will eventually be
 successful.
 
 :ref:`MPI_Cancel` can be used to cancel a communication that uses a persistent
-request (see Section 3.9 in the MPI-1 Standard, "Persistent
+request (see Section 3.9 in the `MPI Standard <https://www.mpi-forum.org/docs/>`_, "Persistent
 Communication Requests") in the same way it is used for nonpersistent
 requests. A successful cancellation cancels the active communication,
 but not the request itself. After the call to :ref:`MPI_Cancel` and the

diff --git a/docs/man-openmpi/man3/MPI_Cart_coords.3.rst b/docs/man-openmpi/man3/MPI_Cart_coords.3.rst
@@ -5,7 +5,7 @@ MPI_Cart_coords
 
 .. include_body
 
-:ref:`MPI_Cart_coords` - Determines process coords in Cartesian topology
+:ref:`MPI_Cart_coords` |mdash| Determines process coords in Cartesian topology
 given rank in group.
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Cart_create.3.rst b/docs/man-openmpi/man3/MPI_Cart_create.3.rst
@@ -5,7 +5,7 @@ MPI_Cart_create
 
 .. include_body
 
-:ref:`MPI_Cart_create` - Makes a new communicator to which Cartesian
+:ref:`MPI_Cart_create` |mdash| Makes a new communicator to which Cartesian
 topology information has been attached.
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Cart_get.3.rst b/docs/man-openmpi/man3/MPI_Cart_get.3.rst
@@ -5,7 +5,7 @@ MPI_Cart_get
 
 .. include_body
 
-:ref:`MPI_Cart_get` - Retrieves Cartesian topology information associated with
+:ref:`MPI_Cart_get` |mdash| Retrieves Cartesian topology information associated with
 a communicator.
 
 SYNTAX

diff --git a/docs/man-openmpi/man3/MPI_Cart_map.3.rst b/docs/man-openmpi/man3/MPI_Cart_map.3.rst
@@ -5,7 +5,7 @@ MPI_Cart_map
 
 .. include_body
 
-:ref:`MPI_Cart_map` - Maps process to Cartesian topology information.
+:ref:`MPI_Cart_map` |mdash| Maps process to Cartesian topology information.
 
 SYNTAX
 ------

diff --git a/docs/man-openmpi/man3/MPI_Cart_rank.3.rst b/docs/man-openmpi/man3/MPI_Cart_rank.3.rst
@@ -5,7 +5,7 @@ MPI_Cart_rank
 
 .. include_body
 
-:ref:`MPI_Cart_rank` - Determines process rank in communicator given Cartesian
+:ref:`MPI_Cart_rank` |mdash| Determines process rank in communicator given Cartesian
 location.
 
 SYNTAX
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 +6,7 @@ MPI_Abort @@
     .. include_body
-    :ref:`MPI_Abort` - Terminates MPI execution environment.
+    :ref:`MPI_Abort` |mdash| Terminates MPI execution environment.
     SYNTAX
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,7 +6,7 @@ MPI_Attr_put

		.. include_body

		:ref:`MPI_Attr_put` - Stores attribute value associated with a key -- \|deprecated_favor\| :ref:`MPI_Comm_set_attr`.
		:ref:`MPI_Attr_put` \|mdash\| Stores attribute value associated with a key \|mdash\| \|deprecated_favor\| :ref:`MPI_Comm_set_attr`.



Expand Down