Skip to content

More docs updates #10762

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

Merged
merged 3 commits into from
Sep 7, 2022
Merged

More docs updates #10762

merged 3 commits into from
Sep 7, 2022

Conversation

jsquyres
Copy link
Member

@jsquyres jsquyres commented Sep 5, 2022

See individual commit messages for details.

NOTE: To see the new "tuning" docs page that contains material ported/updated/converted from the FAQ, see https://ompi--10762.org.readthedocs.build/en/10762/running-apps/tuning.html

@jsquyres
Copy link
Member Author

jsquyres commented Sep 6, 2022

Pushed a few text tweaks and spelling corrections this morning. @awlauria this is ready to review. See https://ompi--10762.org.readthedocs.build/en/10762/running-apps/tuning.html for the bulk of the new material in this PR.

@jsquyres jsquyres requested a review from gpaulsen September 6, 2022 15:03
@jsquyres
Copy link
Member Author

jsquyres commented Sep 6, 2022

@jjhursey Updated. The bulk of the changes are visible here: https://ompi--10762.org.readthedocs.build/en/10762/running-apps/tuning.html

Copy link
Member

@jjhursey jjhursey left a comment

Choose a reason for hiding this comment

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

Thanks!

Trivial change: put the explanation text *before* the example.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
This file was a placeholder and did not contain any useful content,
anyway.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
Moved a bunch of MCA-related content out of faq/general-tuning to a
new file in running-apps/tuning.rst.

Removed AMCA documentation because that functionality has morphed into
the "--tuned" functionality.  Indeed, the --am CLI parameter is
silently converted to --tuned.

Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
@jsquyres
Copy link
Member Author

jsquyres commented Sep 6, 2022

Had to force push the same commits (rebased to change their hashes) to un-stick the AWS Jenkins on this PR.

@jsquyres jsquyres merged commit c97c4ee into open-mpi:main Sep 7, 2022
@jsquyres jsquyres deleted the pr/docs-updates branch September 7, 2022 01:38
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.

2 participants