ompi
ompi copied to clipboard
Adding man pages to document ULFM functions
Adding man pages that document ULFM functions.
The function are documented in the form that assumes pending PRs #10507 #9925 are merged prior.
@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'
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?
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 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.
bot:retest
Thanks @abouteiller. Please also cherry pick to v5.0.x.