Skip to content

Commit abe62d2

Browse files
committed
Expose MPI_VERSION and MPI_SUBVERSION to docs.
Signed-off-by: Austen Lauria <awlauria@us.ibm.com>
1 parent 380becc commit abe62d2

File tree

4 files changed

+10
-5
lines changed

4 files changed

+10
-5
lines changed

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +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']}"
5557

5658
# "release" is a sphinx config variable: assign it to the computed
5759
# Open MPI version number. The ompi_ver string begins with a "v"; the
@@ -196,4 +198,7 @@ def _doit(topdir):
196198
.. |autoconf_min_version| replace:: {autoconf_min_version}
197199
.. |libtool_min_version| replace:: {libtool_min_version}
198200
.. |flex_min_version| replace:: {flex_min_version}
201+
.. |mpi_standard_version| replace:: {mpi_standard_version}
202+
.. |mpi_standard_subversion| replace:: {mpi_standard_subversion}
203+
199204
"""

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ Output Parameters
5454
Description
5555
-----------
5656

57-
Since Open MPI is MPI 3.1 compliant, this function will return a
58-
``version`` value of 3 and a subversion value of 1 for this release.
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.
5959

6060
Note
6161
----

docs/man-openmpi/man5/Open-MPI.5.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ message-passing programs that would be efficient, flexible, and
2323
portable.
2424

2525
The outcome, known as the MPI Standard, was first published in 1993; its
26-
most recent version (MPI-3.1) was published in June 2015. Open MPI
27-
includes all MPI 3.1-compliant routines.
26+
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.
2828

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

docs/release-notes/mpi.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ MPI Functionality and Features
44
MPI Standard conformance
55
------------------------
66

7-
In the Open MPI |ompi_series| series, all MPI-3.1 functionality is
7+
In the Open MPI |ompi_series| series, all MPI-|mpi_standard_version|.|mpi_standard_subversion| functionality is
88
supported. Some MPI-4.0 functionality is supported, but not all of
99
it.
1010

0 commit comments

Comments
 (0)