v5.0: A variety of docs updates #10838
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* Typo fixes * Add :ref: links to man pages (mostly `mpirun` and `ompi_info`) * Add notes for contributors about PR'ing to `main` first and then cherry-picking to release branches later. Thanks to @jolivain suggesting that we add this policy to the docs. * Include contributor suggestion to submit fixes to the docs. * Renamed Developers -> Git to "GitHub, Git, and related topics". Added info about: * Git commits and a reference to the contributors declaration (in contributors.rst) * Branching scheme * Details about PR to main first and cherry-picking to release branches * A few words about Github PR CI / MTT * Added information about running Sphinx, and how to view the Sphinx docs locally * Added notes about how to view man pages locally * Added a placeholder oshrun.1 man page (it just refers to mpirun.1) * Per open-mpi#10772 (comment), discuss PMIx and PRRTE MCA * Mention Perl and Python as tools required by Open MPI developers * Expanded on some "advice for packagers" from the "required support dependencies" section, and moved it to its own section: * Don't use Open MPI's bundled sub-packages (Libevent, Hwloc, PMIx, PRTE) * Discussion of components: included in project libraries vs. DSOs * Add short "prerequisites" section for running MPI apps Signed-off-by: Jeff Squyres <[email protected]> (cherry picked from commit 061f908)
awlauria
approved these changes
Sep 26, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
mpirunandompi_info)mainfirst and then cherry-picking to release branches later. Thanks to @jolivain suggesting that we add this policy to the docs.Signed-off-by: Jeff Squyres [email protected]
(cherry picked from commit 061f908)
This is the v5.0.x PR corresponding to the main PR #10793