v5.0.x: A bunch of docs updates #12069
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
Clarify wording; we're really just talking about multi-threaded applications. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit a1b40a4)
Per suggestion from Markus Blatt, add in language similar to what we have in other man pages about how the MPI_ERROR field will not be initialized in the status in the following man pages: * MPI_Imrecv * MPI_Iprobe * MPI_Mrecv * MPI_Probe * MPI_Recv * MPI_Sendrecv * MPI_Sendrecv_replace Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 97b3a58)
No actual verbiage changes or content changes; just fixing a bunch of RST minor errors (e.g., things that should have been in fixed-width font that weren't). Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 811ffef)
Add text about status to the MPI_Mrecv.3/MPI_Imrecv.3 man pages that exists in other receive-like functions. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 6a0b54b)
Slightly update the text about the output status in MPI_Test* and MPI_Wait* functions: * Link out to the MPI standard (rather than refer to outdated versions of the standard) * Slightly tweak the wording * Minor RST formatting fixes Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 47654ef)
No other text or content changes. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 8773071)
No other text or content changes. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit a57b67b)
Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 5619144)
Instead of having hard-coded references to old versions of the MPI standard, link out to the MPI Forum web site docs page, and update the cited section of the doc to be something that exists in both the older versions of the MPI standard and also in the current (MPI-4.1) standard. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 99d7c3c)
Where relevant, replace specific references to MPI-1 to generic references to the MPI standard (linked out to the MPI Forum web site) with either a chapter/section number that is still correct, or, if the section/chapter number has changed over time, use the section/chapter title (which is correct in both the old version of the MPI standard and the current [MPI-4.1] version). In a few places, this also carried a few trivial RST formatting updates, and sections were re-flowed after adding the link to the MPI Forum web site, but in general, no other text or content changed. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit 5da4cfd)
Just putting some text in fixed-width font, etc. No text or content changes. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit ffa33de)
Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit e0b69e4)
Use the word "legacy" when referring to MPI-1-specific behavior, and "current" when comparing to today's behavior. Signed-off-by: Jeff Squyres <jeff@squyres.com> (cherry picked from commit fbbd267)
wenduwan
approved these changes
Nov 13, 2023
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.
This is the v5.0.x PR corresponding to #12058
See individual commit messages for details.