Merge pull request open-mpi#10748 from awlauria/minor_version_cleanup

Export MPI_VERSION to docs.

Author: awlauria

autogen.pl

@@ -1090,6 +1090,12 @@ sub export_version {
     $m4 .= "m4_define([OMPI_${name}_NUMERIC_MIN_VERSION], [$hex])\n";
 }
 
+sub export_mpi_version {
+    my ($name,$version) = @_;
+    $version =~ s/[^a-zA-Z0-9,.]//g;
+    $m4 .= "m4_define([$name], [$version])\n";
+}
+
 sub get_and_define_min_versions() {
 
     open(IN, "VERSION") || my_die "Can't open VERSION";
@@ -1131,6 +1137,16 @@ ()
                   export_version("EVENT", $fields[1]);
               }
           }
+          elsif($fields[0] eq "mpi_standard_version") {
+              if ($fields[1] ne "\n") {
+                  export_mpi_version("MPI_VERSION_NUM", $fields[1]);
+              }
+          }
+          elsif($fields[0] eq "mpi_standard_subversion") {
+              if ($fields[1] ne "\n") {
+                  export_mpi_version("MPI_SUBVERSION_NUM", $fields[1]);
+              }
+          }
     }
     close(IN);
 }

config/opal_get_version.m4

@@ -100,27 +100,3 @@ m4_define([OPAL_GET_VERSION],[
                  [AC_MSG_RESULT([$$2_REPO_REV])])
     fi
 ])
-
-# OPAL_GET_MPI_STANDARD_VERSION(version_file)
-# -----------------------------------------------
-# parse version_file for MPI Standard version information, setting
-# the following shell variables:
-#
-#  MPI_VERSION
-#  MPI_SUBVERSION
-m4_define([OPAL_GET_MPI_STANDARD_VERSION],[
-    dnl quote eval to suppress macro expansion with non-GNU m4
-    if test -f "$1"; then
-        srcdir=`dirname $1`
-        mpi_standard_vers=`sed -n "
-        t clear
-        : clear
-        s/^mpi_standard_version/MPI_VERSION/
-        s/^mpi_standard_subversion/MPI_SUBVERSION/
-        t print
-        b
-        : print
-        p" < "$1"`
-        [eval] "$mpi_standard_vers"
-    fi
-])

config/opal_save_version.m4

@@ -66,19 +66,17 @@ AC_DEFUN([OPAL_SAVE_VERSION], [
 
 # OPAL_SAVE_MPI_STANDARD_VERSION(version_file)
 # ----------------------------------------------
-# creates version information for project from version_file, using
-# OPAL_GET_MPI_STANDARD_VERSION().
+# Export MPI versions.
 AC_DEFUN([OPAL_SAVE_MPI_STANDARD_VERSION], [
-    OPAL_GET_MPI_STANDARD_VERSION([$1])
-
-    AC_SUBST([MPI_VERSION])
-    AC_SUBST([MPI_SUBVERSION])
 
-    AC_DEFINE_UNQUOTED([MPI_VERSION], [$MPI_VERSION],
+    AC_DEFINE_UNQUOTED([MPI_VERSION], [MPI_VERSION_NUM],
                        [MPI Standard Major version number])
-    AC_DEFINE_UNQUOTED([MPI_SUBVERSION], [$MPI_SUBVERSION],
+    AC_DEFINE_UNQUOTED([MPI_SUBVERSION], [MPI_SUBVERSION_NUM],
                        [MPI Standard Minor version number])
 
+    AC_SUBST([MPI_VERSION])
+    AC_SUBST([MPI_SUBVERSION])
+
     AC_MSG_CHECKING([MPI Standard version])
-    AC_MSG_RESULT([$MPI_VERSION.$MPI_SUBVERSION])
+    AC_MSG_RESULT([MPI_VERSION_NUM.MPI_SUBVERSION_NUM])
 ])dnl

docs/conf.py

@@ -52,6 +52,8 @@
 autoconf_min_version = f"{ompi_data['autoconf_min_version']}"
 libtool_min_version = f"{ompi_data['libtool_min_version']}"
 flex_min_version = f"{ompi_data['flex_min_version']}"
+mpi_standard_version = f"{ompi_data['mpi_standard_version']}"
+mpi_standard_subversion = f"{ompi_data['mpi_standard_subversion']}"
 
 # "release" is a sphinx config variable: assign it to the computed
 # Open MPI version number.  The ompi_ver string begins with a "v"; the
@@ -196,4 +198,7 @@ def _doit(topdir):
 .. |autoconf_min_version| replace:: {autoconf_min_version}
 .. |libtool_min_version| replace:: {libtool_min_version}
 .. |flex_min_version| replace:: {flex_min_version}
+.. |mpi_standard_version| replace:: {mpi_standard_version}
+.. |mpi_standard_subversion| replace:: {mpi_standard_subversion}
+
 """

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

@@ -54,8 +54,8 @@ Output Parameters
 Description
 -----------
 
-Since Open MPI is MPI 3.1 compliant, this function will return a
-``version`` value of 3 and a subversion value of 1 for this release.
+Since Open MPI is MPI-|mpi_standard_version|.|mpi_standard_subversion| compliant, this function will return a
+``version`` value of |mpi_standard_version| and a subversion value of |mpi_standard_subversion| for this release.
 
 Note
 ----

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

@@ -23,8 +23,8 @@ message-passing programs that would be efficient, flexible, and
 portable.
 
 The outcome, known as the MPI Standard, was first published in 1993; its
-most recent version (MPI-3.1) was published in June 2015. Open MPI
-includes all MPI 3.1-compliant routines.
+most recent version (MPI-4.0) was published in June 2021. Open MPI
+includes all MPI |mpi_standard_version|.|mpi_standard_subversion|-compliant routines.
 
 For more information about Open MPI, see https://www.open-mpi.org.
 

docs/release-notes/mpi.rst

@@ -4,7 +4,7 @@ MPI Functionality and Features
 MPI Standard conformance
 ------------------------
 
-In the Open MPI |ompi_series| series, all MPI-3.1 functionality is
+In the Open MPI |ompi_series| series, all MPI-|mpi_standard_version|.|mpi_standard_subversion| functionality is
 supported.  Some MPI-4.0 functionality is supported, but not all of
 it.