Skip to content

Commit

Permalink
docs: document minimum PMIx version needed
Browse files Browse the repository at this point in the history
This value is already in VERSIONS and is propagated to the RST docs
through conf.py; just add some verbiage to show that value to the
user.

Signed-off-by: Jeff Squyres <jeff@squyres.com>
  • Loading branch information
jsquyres authored and rhc54 committed Oct 1, 2023
1 parent dc2df36 commit 7bffaf7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,18 @@ PMIx Reference RunTime Environment (PRRTE). More information is
available `in the FAQ section on the PRRTE web site
<https://github.com/openpmix/prrte>`_.

Minimum PMIx version
--------------------

The ``configure`` script in PRRTE |prte_ver| must be able to find an
OpenPMIx installation that is |pmix_min_version| or higher. If
``configure`` cannot find a suitable OpenPMIx version, it will abort
with an error.

If OpenPMIx cannot be found in default preprocessor and linker search
paths, you can specify the ``--with-pmix=DIR`` CLI option to tell
``configure`` where to find it.


Developer Builds
----------------
Expand Down

0 comments on commit 7bffaf7

Please sign in to comment.