Skip to content

docs: some functions (currently) require mpirun#12992

Merged
jsquyres merged 1 commit intoopen-mpi:mainfrom
jsquyres:pr/add-mpirun-only-notes
Jan 6, 2026
Merged

docs: some functions (currently) require mpirun#12992
jsquyres merged 1 commit intoopen-mpi:mainfrom
jsquyres:pr/add-mpirun-only-notes

Conversation

@jsquyres
Copy link
Member

Add a note to several MPI API man pages that they (currently) require being launched via mpirun / mpiexec, and that launching in other environments may result in undefined behavior.

@hppritcha
Copy link
Member

MPI_COMM_CREATE_FROM_GROUP also needs to be updated.

@jsquyres jsquyres force-pushed the pr/add-mpirun-only-notes branch 2 times, most recently from 3be03c2 to 3e32715 Compare December 23, 2024 18:09
@jsquyres
Copy link
Member Author

MPI_COMM_CREATE_FROM_GROUP also needs to be updated.

Thanks! Updated.

@rhc54
Copy link
Contributor

rhc54 commented Dec 23, 2024

Not a function, but perhaps should point out that the FT feature also requires mpirun. And of course, anything that calls connect/accept somewhere in its code path is going to hit this limitation.

You'll also likely need to do a bit of an audit for things that call nextcid at some point - I'm not sure when the PMIx code down there gets executed, but you might hit it way down in the call stack.

@hppritcha
Copy link
Member

do we want to merge this into main at some point soon?

Add a note to several MPI API man pages and the top-level MPI FT page
that all of this functionality (currently) require being launched via
mpirun / mpiexec, and that launching in other environments may result
in undefined behavior.

Signed-off-by: Jeff Squyres <jeff@squyres.com>
@jsquyres jsquyres force-pushed the pr/add-mpirun-only-notes branch from 3e32715 to f173ca9 Compare January 5, 2026 20:27
@jsquyres jsquyres marked this pull request as ready for review January 5, 2026 20:28
@jsquyres
Copy link
Member Author

jsquyres commented Jan 5, 2026

Added a note about FT requiring mpirun as well. Let's get this in (and cherry-picked to v6).

@hppritcha hppritcha self-requested a review January 6, 2026 02:45
@jsquyres jsquyres merged commit 1ffad76 into open-mpi:main Jan 6, 2026
13 of 14 checks passed
@jsquyres jsquyres deleted the pr/add-mpirun-only-notes branch January 6, 2026 14:50
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.

3 participants