Skip to content

Commit 1c595f2

Browse files
jsquyreswckzhang
authored andcommitted
docs: fix rendering of MPI standards versions
RST apparently does not render |foo|.|bar| properly. Specifically: the "foo" macro will render properly, but the "bar" macro will not. As such, split the MPI standard version into three macros so that we don't have to render MPI's major and minor versions in the pattern that RST will not render correctly. Also add a cross reference from MPI_Get_version.3 to the release notes where we talk about Open MPI's MPI conformance. Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent 88120e2 commit 1c595f2

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

docs/conf.py

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@
5252
autoconf_min_version = f"{ompi_data['autoconf_min_version']}"
5353
libtool_min_version = f"{ompi_data['libtool_min_version']}"
5454
flex_min_version = f"{ompi_data['flex_min_version']}"
55-
mpi_standard_version = f"{ompi_data['mpi_standard_version']}"
56-
mpi_standard_subversion = f"{ompi_data['mpi_standard_subversion']}"
55+
mpi_standard_major_version = f"{ompi_data['mpi_standard_version']}"
56+
mpi_standard_minor_version = f"{ompi_data['mpi_standard_subversion']}"
5757

5858
# "release" is a sphinx config variable: assign it to the computed
5959
# Open MPI version number. The ompi_ver string begins with a "v"; the
@@ -219,8 +219,9 @@ def _doit(topdir):
219219
.. |autoconf_min_version| replace:: {autoconf_min_version}
220220
.. |libtool_min_version| replace:: {libtool_min_version}
221221
.. |flex_min_version| replace:: {flex_min_version}
222-
.. |mpi_standard_version| replace:: {mpi_standard_version}
223-
.. |mpi_standard_subversion| replace:: {mpi_standard_subversion}
222+
.. |mpi_standard_version| replace:: {mpi_standard_major_version}.{mpi_standard_minor_version}
223+
.. |mpi_standard_major_version| replace:: {mpi_standard_major_version}
224+
.. |mpi_standard_minor_version| replace:: {mpi_standard_minor_version}
224225
.. |deprecated_favor| replace:: this routine is deprecated in favor of
225226
226227
"""

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,11 @@ OUTPUT PARAMETERS
5454
DESCRIPTION
5555
-----------
5656

57-
Since Open MPI is MPI-|mpi_standard_version|.|mpi_standard_subversion| compliant, this function will return a
58-
``version`` value of |mpi_standard_version| and a subversion value of |mpi_standard_subversion| for this release.
57+
Since Open MPI |ompi_ver| is MPI-|mpi_standard_version| compliant (see
58+
:ref:`this page for more details about Open MPI standards conformance
59+
<mpi-standard-conformance-label>`) this function will return a
60+
``version`` value of |mpi_standard_major_version| and a ``subversion``
61+
value of |mpi_standard_minor_version| for this release.
5962

6063
NOTE
6164
----

docs/man-openmpi/man7/Open-MPI.7.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ portable.
2424

2525
The outcome, known as the MPI Standard, was first published in 1993; its
2626
most recent version (MPI-4.0) was published in June 2021. Open MPI
27-
includes all MPI |mpi_standard_version|.|mpi_standard_subversion|-compliant routines.
27+
includes all MPI |mpi_standard_version|-compliant routines.
2828

2929
For more information about Open MPI, see https://www.open-mpi.org.
3030

docs/release-notes/mpi.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
MPI Functionality and Features
22
==============================
33

4+
.. _mpi-standard-conformance-label:
5+
46
MPI Standard conformance
57
------------------------
68

0 commit comments

Comments
 (0)