Skip to content
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

Update mpirun man page #11730

Closed
Tracked by #10480
qkoziol opened this issue Jun 5, 2023 · 7 comments
Closed
Tracked by #10480

Update mpirun man page #11730

qkoziol opened this issue Jun 5, 2023 · 7 comments

Comments

@qkoziol
Copy link
Contributor

qkoziol commented Jun 5, 2023

The mpirun man page is currently essentially an RST-ified version of OMPI v4.1’s man page. There has been some light editing

  • Eliminated all -foo options
  • Modernized some of the examples
  • Add that we do support “single dash” mpirun options, but we don’t want people to do that.
  • Much more work needs to be done to update it for all the PRTE changes since Open MPI v4.1.x.
@qkoziol qkoziol changed the title is currently essentially an RST-ified version of OMPI v4.1’s man page. There has been some light editing Update mpirun man page Jun 5, 2023
@qkoziol
Copy link
Contributor Author

qkoziol commented Jun 5, 2023

Split out from #10480

@qkoziol
Copy link
Contributor Author

qkoziol commented Jun 27, 2023

Status update on this:
PRRTE will move to generating its help text files from RST docs, which will greatly ease the process of updating (and keeping updated) the mpirun man page. @jsquyres will update the infrastructure in PRRTE to enable that, then I'll resume updating the mpirun man page.

@rhc54
Copy link
Contributor

rhc54 commented Jun 28, 2023

Just to be clear:

PRRTE will move to generating its help text files from RST docs

This is purely an experiment at this time. @jsquyres is going to try to make this work. If he can successfully generate the text files in their current form, then we will look at the required RST syntax to see if it is overly complex. If it isn't, then we can go this route - otherwise, we won't.

@jsquyres
Copy link
Member

jsquyres commented Jul 11, 2023

We have a draft PR where we're doing the PRTE work: openpmix/prrte#1765
Corresponding Open MPI PR: #11820

@janjust
Copy link
Contributor

janjust commented Sep 7, 2023

@jsquyres just curious - do we have updates on: openpmix/prrte/pull/1765? Any eta?

@jsquyres
Copy link
Member

OMPI main PR merged. All PRRTE work is now also merged, on both master and v3.0.

OMPI v5.0.x cherry pick PR is now up: #11943

@awlauria
Copy link
Contributor

Thanks @jsquyres .

v5.0.x pr merged - can we close?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants