Skip to content

doc/mansrc: Added semantic descriptions for functions - #7869

Open
KLeoUIC wants to merge 2 commits into
pmodels:mainfrom
KLeoUIC:0707_semantics
Open

KLeoUIC wants to merge 2 commits into
pmodels:mainfrom
KLeoUIC:0707_semantics

Conversation

@KLeoUIC

@KLeoUIC KLeoUIC commented Jul 9, 2026 •

Copy link
Copy Markdown
Collaborator

Pull Request Description

Currently documentation is very minimal or boilerplate and aimed at developers and those familiar with MPI. It leaves a gap for those learning MPI through MPICH and users looking to orient themselves in the large standard. As MPIX functions are not in the standard yet users have no easy way of looking up their usage beyond the one sentence description manpages have currently. The generated descriptions provide a way of getting more information for users who do not wish to scour the codebase or search for papers where the function was proposed.

Pull request provides semantic descriptions based off of the latest MPI Standard and source code.
Directions and script for making new descriptions in Box.

Author Checklist

  • Provide Description
    Particularly focus on why, not what. Reference background, issues, test failures, xfail entries, etc.
  • Commits Follow Good Practice
    Commits are self-contained and do not do two things at once.
    Commit message is of the form: module: short description
    Commit message explains what's in the commit.
  • Passes All Tests
    Whitespace checker. Warnings test. Additional tests via comments.
  • Contribution Agreement
    For non-Argonne authors, check contribution agreement.
    If necessary, request an explicit comment from your companies PR approval manager.

@KLeoUIC KLeoUIC changed the title 0707_semantics 0707_semantics: Added semantic descriptions for MPI Standard functions Jul 10, 2026
@KLeoUIC KLeoUIC changed the title 0707_semantics: Added semantic descriptions for MPI Standard functions doc/mansrc: Added semantic descriptions for MPI Standard functions Jul 10, 2026
@KLeoUIC KLeoUIC changed the title doc/mansrc: Added semantic descriptions for MPI Standard functions doc/mansrc: Added semantic descriptions for functions Jul 10, 2026
@hzhou

hzhou commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

test:mpich/doc

1 similar comment
@hzhou

hzhou commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

test:mpich/doc

@sonjahapp sonjahapp left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I reviewed text for MPI Session and spawn procedures. Text looks good to me except for the single comment I made on MPI_Comm_spawn.

Comment thread doc/mansrc/semantics.adoc Resolved
@hzhou hzhou added the 5.1.x label Nov 9, 2026
KLeoUIC and others added 2 commits November 8, 2026 22:08
Instructions and generating script in Box
We should only comment on performance if it is specifically verified
with MPICH. It does not belong as a sementic block anyway.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants