Skip to content

Minor text improvements #989

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

Open
wgropp opened this issue Mar 31, 2025 · 0 comments
Open

Minor text improvements #989

wgropp opened this issue Mar 31, 2025 · 0 comments
Labels
mpi-6 For inclusion in the MPI 5.1 or 6.0 standard

Comments

@wgropp
Copy link

wgropp commented Mar 31, 2025

Problem

In reviewing the mpi-50-rc document, the following were identified as possible improvements in the document. Page and lines refer to the mpi-50-rc of February, 2025.

Improved Text:

  1. p30: Replace "However, the examples have not been carefully checked or verified." with "However, while the examples have been reviewed, the MPI Forum does not guarantee that they do not contain any errors."
  2. p 275, line 41. Change "MPI can be designed" to "An MPI implementation can be designed". The current text is incorrect, though the meaning is probably clear to readers.
  3. p 299, line 5. Replace "dangerous" with "erroneous".
  4. p 308, line 24. This text, "only communicators can be used in communication operations", dates from MPI-1. Note that MPI_WIN_POST and MPI_WIN_START take groups as arguments. Could just delete this clause.
  5. p 515. Could explain the syntax of <...>; also in lines 37-44, there are < > where there could be some text, e.g.,
  6. p 516. Example 11.18 has truly ancient systems. This could be modernized.
  7. p 826, line 24 has an explicit page reference. Is that desirable?
  8. p 1106. The introductory text doesn't explain that language-neutral examples are also listed in all caps (this is why I suggested that Fortran examples be listed in lower case, but the forum rejected that suggestion).
  9. p 1108. Some examples don't appear to have routines associated with them. For example, Example 6.31 (or one near there).
  10. p 1123. MPI_COUNT_KIND has two "primary" definitions. Should not be the one on p 874 (see the "Variable address size (Fortran only) table).
  11. p 1129. MPI_Aint also has two primary definitions, on pages 21 and 131.

Proposal

Chapter committees to consider these suggestions

Changes to the Text

As noted above

Impact on Implementations

None

Impact on Users

Improved document

References and Pull Requests

@wgropp wgropp added the mpi-6 For inclusion in the MPI 5.1 or 6.0 standard label Mar 31, 2025
@github-project-automation github-project-automation bot moved this to To Do in MPI Next Mar 31, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
mpi-6 For inclusion in the MPI 5.1 or 6.0 standard
Projects
Status: To Do
Development

No branches or pull requests

1 participant