Skip to content
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

docs: add notes about dependency versions #12836

Merged
merged 2 commits into from
Oct 8, 2024

Conversation

jsquyres
Copy link
Member

@jsquyres jsquyres commented Oct 1, 2024

In general, recommend using the latest versions of Hwloc, OpenPMIx, and PRRTE.


You can see the rendered version of this PR here: https://ompi--12836.org.readthedocs.build/en/12836/installing-open-mpi/required-support-libraries.html

Copy link
Contributor

@rhc54 rhc54 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Won't let me comment inline, so I'll add a note here. Line 81 references the PMIx standard page, yet the text all talks about the library. Would it make sense to point to the library's page or repo? Or perhaps point to the RTD site for the library?

Copy link
Contributor

@rhc54 rhc54 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I confess I struggle with this "OpenPMIx" nonsense, but I guess it is where we are for the moment. Note that there is no space in the name (haha).

@jsquyres
Copy link
Member Author

jsquyres commented Oct 2, 2024

Note that there is no space in the name (haha).

You're killing me, Smalls! 😄 Fixed.

@rhc54
Copy link
Contributor

rhc54 commented Oct 2, 2024

I was actually suggesting using PMIx everywhere in the text and just change the link to point to the openpmix rtd site - but that's just me 😉

In general, recommend using the latest versions of Hwloc, Open PMIx,
and PRRTE.

Signed-off-by: Jeff Squyres <[email protected]>
Also update the URL to point to the OpenPMIx RTD docs, and add a
clarification that we used the term "PMIx" heavily throughout the rest
of the docs to refer to "OpenPMIx".

Signed-off-by: Jeff Squyres <[email protected]>
@jsquyres
Copy link
Member Author

jsquyres commented Oct 8, 2024

Ok, I think this PR is ready for review / approval.

@jsquyres jsquyres merged commit d14af58 into open-mpi:main Oct 8, 2024
20 checks passed
@jsquyres jsquyres deleted the pr/docs/dependency-versions branch October 8, 2024 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants