Skip to content

Commit 6241541

Browse files
committed
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 <[email protected]>
1 parent 6136894 commit 6241541

File tree

5 files changed

+36
-8
lines changed

5 files changed

+36
-8
lines changed

.gitmodules

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[submodule "prrte"]
22
path = 3rd-party/prrte
3-
url = ../../openpmix/prrte
3+
url = ../../open-mpi/prrte
44
branch = v3.0
55
[submodule "openpmix"]
66
path = 3rd-party/openpmix

docs/installing-open-mpi/packagers.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,14 @@ binary Open MPI packages should limit themselves solely to Open MPI
1717
artifacts. Specifically: ensure to configure and build Open MPI
1818
against external installations of these required packages.
1919

20+
.. note:: It should be noted that Open MPI |ompi_series| may include
21+
an Open MPI-specific version of the PRRTE software package.
22+
This may include post-release commits from the upstream
23+
PRRTE repository, and/or include Open MPI-specific commits.
24+
Care will need to be taken to ensure that downstream Open
25+
MPI packages include functionality and bug fixes that are
26+
included in the Open MPI distribution tarballs.
27+
2028
Packagers may therefore wish to configure Open MPI with something like
2129
the following:
2230

docs/installing-open-mpi/required-support-libraries.rst

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -108,14 +108,26 @@ system.
108108
* This library is optional in some environments. See below.
109109
* **Minimum version required:** |prte_min_version|
110110

111-
.. note:: While the minimum version of PRRTE will *work*, it may
112-
still have bugs and/or have less functionality as
113-
compared to later versions. For example, if you build
114-
and run with |prte_min_version|, you will not get a
115-
fully-populated ``mpirun(1)`` man page.
111+
.. important:: It should be noted that Open MPI |ompi_series| may
112+
include an Open MPI-specific version of the PRRTE
113+
software package. This may include post-release
114+
commits from the upstream PRRTE repository, and/or
115+
include Open MPI-specific commits. As such, the
116+
PRRTE minimum version |prte_min_version| may not
117+
actually include all bug fixes and functionality
118+
that is included in the PRRTE that is embedded in
119+
official Open MPI distributions.
120+
121+
.. note:: Additionally, while the minimum version of PRRTE will
122+
*work*, it may still have bugs and/or have less
123+
functionality as compared to later versions. For
124+
example, if you build and run with |prte_min_version|,
125+
you will not get a fully-populated ``mpirun(1)`` man
126+
page.
116127

117128
The Open MPI community generally recomends using the
118-
latest available version of PRRTE unless there is a
129+
latest available version of PRRTE and/or the PRRTE
130+
bundled in Open MPI distributions unless there is a
119131
specific reason not to.
120132

121133
* **Version embedded in Open MPI distribution:**

docs/launching-apps/pmix-and-prrte.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,3 +66,11 @@ nodes.
6666
Open MPI uses PRRTE to deal with the practical issues of the back-end
6767
run-time environment such as launching, monitoring, killing, and
6868
reaping remote processes.
69+
70+
.. note:: The version of PRRTE bundled in the Open MPI |ompi_series|
71+
may not be an official release of the upstream PRRTE
72+
software project. Instead, it may include commits from the
73+
upstream PRRTE repository that were created after an
74+
official release, and/or may contain Open MPI-specific
75+
commits that were never included in any official upstream
76+
PRRTE release.

0 commit comments

Comments
 (0)