ompi icon indicating copy to clipboard operation
ompi copied to clipboard

Adding man pages to document ULFM functions

Open abouteiller opened this issue 2 years ago • 4 comments

Adding man pages that document ULFM functions.

The function are documented in the form that assumes pending PRs #10507 #9925 are merged prior.

abouteiller avatar Sep 09 '22 14:09 abouteiller

@abouteiller CI generated Sphinx errors:

/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10781/docs/man-openmpi/man3/MPIX_Comm_agree.3.rst:83: WARNING: undefined label: 'mpi_comm_agree'
/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10781/docs/man-openmpi/man3/MPIX_Comm_agree.3.rst:79: WARNING: undefined label: 'mpi_comm_agree'
/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10781/docs/man-openmpi/man3/MPIX_Comm_shrink.3.rst:86: WARNING: undefined label: 'mpi_comm_shrink'
/home/docs/checkouts/readthedocs.org/user_builds/ompi/checkouts/10781/docs/man-openmpi/man3/MPIX_Comm_shrink.3.rst:90: WARNING: undefined label: 'mpi_comm_shrink'

jsquyres avatar Sep 09 '22 15:09 jsquyres

Oh, I just saw your not on the description: will merging https://github.com/open-mpi/ompi/pull/10507 and https://github.com/open-mpi/ompi/pull/9925 fix the Sphinx errors?

jsquyres avatar Sep 09 '22 15:09 jsquyres

No these were bona fide typos. The reason the PR is dependent upon the other two is that it documents functions that are introduced in them.

abouteiller avatar Sep 11 '22 22:09 abouteiller

@abouteiller Gotcha. Ok, I put this PR in "draft" mode to make sure we don't merge it before https://github.com/open-mpi/ompi/pull/10507 and https://github.com/open-mpi/ompi/pull/9925.

jsquyres avatar Sep 12 '22 15:09 jsquyres

bot:retest

abouteiller avatar Mar 01 '23 00:03 abouteiller

Thanks @abouteiller. Please also cherry pick to v5.0.x.

jsquyres avatar Mar 08 '23 21:03 jsquyres