From 6241541917c9e01166b0ac412eb305b037031c00 Mon Sep 17 00:00:00 2001 From: Jeff Squyres Date: Sun, 18 May 2025 07:57:20 -0400 Subject: [PATCH] Update v5.0.x PRTE submodule to OMPI-specific fork Move the 3rd-party/prrte Git submodule to point to the https://github.com/open-mpi/prrte repo, and update the specific git hash to point to the tip of the v3.0-ompi-v5.0.x branch. This branch points to a few commits beyond the upstream PRTE v3.0.10 tag to include some bug fixes that came in after the v3.0.10 release. The additional commit in the Open MPI fork simply changes the version number in the 3rd-party/prte tree (and adds a few docs) to make it clear that this is an Open MPI-specific version of PRTE, and is not the same as any upstream / community PRTE release. Signed-off-by: Jeff Squyres --- .gitmodules | 2 +- 3rd-party/prrte | 2 +- docs/installing-open-mpi/packagers.rst | 8 +++++++ .../required-support-libraries.rst | 24 ++++++++++++++----- docs/launching-apps/pmix-and-prrte.rst | 8 +++++++ 5 files changed, 36 insertions(+), 8 deletions(-) diff --git a/.gitmodules b/.gitmodules index 22aa7f5a84a..c9478b9995a 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,6 +1,6 @@ [submodule "prrte"] path = 3rd-party/prrte - url = ../../openpmix/prrte + url = ../../open-mpi/prrte branch = v3.0 [submodule "openpmix"] path = 3rd-party/openpmix diff --git a/3rd-party/prrte b/3rd-party/prrte index 0ff51bd532e..8c7c258c0d8 160000 --- a/3rd-party/prrte +++ b/3rd-party/prrte @@ -1 +1 @@ -Subproject commit 0ff51bd532e0a95483cafdc290d22a6cb55a9aef +Subproject commit 8c7c258c0d83fdd58cdb60f08fb0acbe75407d11 diff --git a/docs/installing-open-mpi/packagers.rst b/docs/installing-open-mpi/packagers.rst index c0fb13ea23a..611ad568f38 100644 --- a/docs/installing-open-mpi/packagers.rst +++ b/docs/installing-open-mpi/packagers.rst @@ -17,6 +17,14 @@ binary Open MPI packages should limit themselves solely to Open MPI artifacts. Specifically: ensure to configure and build Open MPI against external installations of these required packages. +.. note:: It should be noted that Open MPI |ompi_series| may include + an Open MPI-specific version of the PRRTE software package. + This may include post-release commits from the upstream + PRRTE repository, and/or include Open MPI-specific commits. + Care will need to be taken to ensure that downstream Open + MPI packages include functionality and bug fixes that are + included in the Open MPI distribution tarballs. + Packagers may therefore wish to configure Open MPI with something like the following: diff --git a/docs/installing-open-mpi/required-support-libraries.rst b/docs/installing-open-mpi/required-support-libraries.rst index 983608a3fb9..c26ba7a51a5 100644 --- a/docs/installing-open-mpi/required-support-libraries.rst +++ b/docs/installing-open-mpi/required-support-libraries.rst @@ -108,14 +108,26 @@ system. * This library is optional in some environments. See below. * **Minimum version required:** |prte_min_version| - .. note:: While the minimum version of PRRTE will *work*, it may - still have bugs and/or have less functionality as - compared to later versions. For example, if you build - and run with |prte_min_version|, you will not get a - fully-populated ``mpirun(1)`` man page. + .. important:: It should be noted that Open MPI |ompi_series| may + include an Open MPI-specific version of the PRRTE + software package. This may include post-release + commits from the upstream PRRTE repository, and/or + include Open MPI-specific commits. As such, the + PRRTE minimum version |prte_min_version| may not + actually include all bug fixes and functionality + that is included in the PRRTE that is embedded in + official Open MPI distributions. + + .. note:: Additionally, while the minimum version of PRRTE will + *work*, it may still have bugs and/or have less + functionality as compared to later versions. For + example, if you build and run with |prte_min_version|, + you will not get a fully-populated ``mpirun(1)`` man + page. The Open MPI community generally recomends using the - latest available version of PRRTE unless there is a + latest available version of PRRTE and/or the PRRTE + bundled in Open MPI distributions unless there is a specific reason not to. * **Version embedded in Open MPI distribution:** diff --git a/docs/launching-apps/pmix-and-prrte.rst b/docs/launching-apps/pmix-and-prrte.rst index 11183f57925..565801bf1df 100644 --- a/docs/launching-apps/pmix-and-prrte.rst +++ b/docs/launching-apps/pmix-and-prrte.rst @@ -66,3 +66,11 @@ nodes. Open MPI uses PRRTE to deal with the practical issues of the back-end run-time environment such as launching, monitoring, killing, and reaping remote processes. + +.. note:: The version of PRRTE bundled in the Open MPI |ompi_series| + may not be an official release of the upstream PRRTE + software project. Instead, it may include commits from the + upstream PRRTE repository that were created after an + official release, and/or may contain Open MPI-specific + commits that were never included in any official upstream + PRRTE release.