Skip to content

Update the ULFM Readme #9927

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Sep 2, 2022
Merged

Update the ULFM Readme #9927

merged 1 commit into from
Sep 2, 2022

Conversation

@abouteiller
Copy link
Member

@abouteiller abouteiller commented Jan 25, 2022

Signed-off-by: Aurelien Bouteiller bouteill@icl.utk.edu

@abouteiller abouteiller self-assigned this Jan 25, 2022
@jsquyres
Copy link
Member

jsquyres commented Jan 26, 2022

@abouteiller Could you make a corresponding change on #8329? That will be the new docs someday -- hopefully in time for v5.0.0.

@awlauria
Copy link
Contributor

awlauria commented Mar 8, 2022

@abouteiller with merging of #8329 this will need to be updated.

jsquyres
jsquyres requested changes Mar 8, 2022
View reviewed changes
Copy link
Member

@jsquyres jsquyres left a comment

Choose a reason for hiding this comment

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

As @awlauria pointed out, this will need to be re-applied to the RST documentation. See https://github.com/open-mpi/ompi/blob/master/docs/features/ulfm.rst.

@jsquyres jsquyres marked this pull request as draft March 9, 2022 14:33
@abouteiller abouteiller force-pushed the ulfm/readme branch 2 times, most recently from 56048a5 to d724405 Compare April 12, 2022 20:24
jsquyres
jsquyres reviewed Apr 12, 2022
View reviewed changes
@abouteiller abouteiller requested a review from jsquyres April 12, 2022 21:17
@abouteiller abouteiller marked this pull request as ready for review April 12, 2022 21:17
jsquyres
jsquyres requested changes Apr 13, 2022
View reviewed changes
@abouteiller abouteiller requested review from jsquyres April 27, 2022 19:10
jsquyres
jsquyres reviewed Apr 27, 2022
View reviewed changes
Copy link
Member

@jsquyres jsquyres left a comment

Choose a reason for hiding this comment

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

A few minor things to fix, and I pushed a commit with a few suggestions. Feel free to squash that into your existing commit.

@jsquyres
Copy link
Member

jsquyres commented Apr 27, 2022

Would it be possible to contribute man pages for the new MPIX functions? They don't have to be enormously detailed, but having the RST for the ??5?? new API functions would be great...

@bosilca bosilca self-assigned this Apr 27, 2022
@abouteiller abouteiller force-pushed the ulfm/readme branch 2 times, most recently from c15a613 to 4f6a291 Compare April 29, 2022 17:14
@abouteiller
Copy link
Member Author

abouteiller commented Apr 29, 2022

Would it be possible to contribute man pages for the new MPIX functions? They don't have to be enormously detailed, but having the RST for the ??5?? new API functions would be great...

Yes, I'll make another PR for this, I have users that have been confused by the doc being outdated and I'd like the corrected doc out ASAP

@jsquyres
Copy link
Member

jsquyres commented May 1, 2022

Would it be possible to contribute man pages for the new MPIX functions? They don't have to be enormously detailed, but having the RST for the ??5?? new API functions would be great...

Yes, I'll make another PR for this, I have users that have been confused by the doc being outdated and I'd like the corrected doc out ASAP

OTOH, adding 5 man pages is quick/easy to do. Might as well get all the docs out there to be consistent. 😄

jsquyres
jsquyres approved these changes Aug 31, 2022
View reviewed changes
Copy link
Member

@jsquyres jsquyres left a comment

Choose a reason for hiding this comment

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

Looks good -- thanks! Want to squash them down to a single commit?

@abouteiller
Update the ULFM Readme
d97ae55 
Comment indentation

Signed-off-by: Aurelien Bouteiller <bouteill@icl.utk.edu>

ulfm readme: review comments from Jeff

Signed-off-by: Aurelien Bouteiller <bouteill@icl.utk.edu>

ulfm readme: Indentation of the 'important' and lists

Signed-off-by: Aurelien Bouteiller <bouteill@icl.utk.edu>
@abouteiller abouteiller merged commit a63bdc6 into open-mpi:main Sep 2, 2022
@abouteiller abouteiller mentioned this pull request Sep 2, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jsquyres jsquyres jsquyres approved these changes

Assignees

@bosilca bosilca

@abouteiller abouteiller

Labels

documentation Target: main

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@abouteiller @jsquyres @awlauria @bosilca