Skip to content

v5.0.x: Update v5.0.x PRTE submodule to OMPI-specific fork #13260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: v5.0.x
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .gitmodules
Original file line number Diff line number Diff line change
@@ -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
Expand Down
8 changes: 8 additions & 0 deletions docs/installing-open-mpi/packagers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
24 changes: 18 additions & 6 deletions docs/installing-open-mpi/required-support-libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:**
Expand Down
8 changes: 8 additions & 0 deletions docs/launching-apps/pmix-and-prrte.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.