Skip to content

docs: Minor updates to MPIX man pages #10916

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

Merged
merged 1 commit into from
Oct 13, 2022

Conversation

jsquyres
Copy link
Member

Add some formulaic text to the MPIX man pages:

  • Indicated that these functions are only present if the corresponding extenion was built
  • Described the available preprocessor macros
  • Added a link to the Open MPI Extensions section
  • Fixed string errors in the example code
  • Used proper #if conditionals in the example
  • Added a See Also section

Signed-off-by: Jeff Squyres [email protected]

@jsquyres
Copy link
Member Author

@edgargabriel New version pushed.

Copy link
Member

@edgargabriel edgargabriel 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!

@jsquyres jsquyres force-pushed the pr/mpix-man-page-updates branch from 11db6d9 to 91f4346 Compare October 12, 2022 21:09
Add some formulaic text to the MPIX man pages:

* Indicated that these functions are only present if the corresponding
  extenion was built
* Described the available preprocessor macros
* Added a link to the Open MPI Extensions section
* Fixed string errors in the example code
* Used proper #if conditionals in the example
* Added a See Also section

Signed-off-by: Jeff Squyres <[email protected]>
@jsquyres jsquyres force-pushed the pr/mpix-man-page-updates branch from 91f4346 to cc976e7 Compare October 13, 2022 14:34
@jsquyres
Copy link
Member Author

jsquyres commented Oct 13, 2022

Rebased to pick up the mailmap fix so that CI will pass.

@jsquyres jsquyres merged commit de23ae3 into open-mpi:main Oct 13, 2022
@jsquyres jsquyres deleted the pr/mpix-man-page-updates branch October 13, 2022 17:18
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