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

doc: create alias man pages for large count routines #7112

Merged
merged 1 commit into from
Aug 26, 2024

Conversation

hzhou
Copy link
Contributor

@hzhou hzhou commented Aug 21, 2024

Pull Request Description

We list the large count routines in the same man page of their normal count routines, but the entries are missing. This commit creates the alias man pages for them.

Fixes #6973
[skip warnings]

Author Checklist

  • Provide Description
    Particularly focus on why, not what. Reference background, issues, test failures, xfail entries, etc.
  • Commits Follow Good Practice
    Commits are self-contained and do not do two things at once.
    Commit message is of the form: module: short description
    Commit message explains what's in the commit.
  • Passes All Tests
    Whitespace checker. Warnings test. Additional tests via comments.
  • Contribution Agreement
    For non-Argonne authors, check contribution agreement.
    If necessary, request an explicit comment from your companies PR approval manager.

@hzhou
Copy link
Contributor Author

hzhou commented Aug 21, 2024

Locally verified:

$ ls mpich-4.3.0a1/man/man3/*_c.3
mpich-4.3.0a1/man/man3/MPI_Accumulate_c.3                mpich-4.3.0a1/man/man3/MPI_Get_accumulate_c.3            mpich-4.3.0a1/man/man3/MPI_Reduce_scatter_block_c.3
mpich-4.3.0a1/man/man3/MPI_Allgather_c.3                 mpich-4.3.0a1/man/man3/MPI_Get_c.3                       mpich-4.3.0a1/man/man3/MPI_Reduce_scatter_block_init_c.3
mpich-4.3.0a1/man/man3/MPI_Allgather_init_c.3            mpich-4.3.0a1/man/man3/MPI_Get_count_c.3                 mpich-4.3.0a1/man/man3/MPI_Reduce_scatter_c.3
mpich-4.3.0a1/man/man3/MPI_Allgatherv_c.3                mpich-4.3.0a1/man/man3/MPI_Get_elements_c.3              mpich-4.3.0a1/man/man3/MPI_Reduce_scatter_init_c.3
mpich-4.3.0a1/man/man3/MPI_Allgatherv_init_c.3           mpich-4.3.0a1/man/man3/MPI_Iallgather_c.3                mpich-4.3.0a1/man/man3/MPI_Register_datarep_c.3
mpich-4.3.0a1/man/man3/MPI_Allreduce_c.3                 mpich-4.3.0a1/man/man3/MPI_Iallgatherv_c.3               mpich-4.3.0a1/man/man3/MPI_Rget_accumulate_c.3
mpich-4.3.0a1/man/man3/MPI_Allreduce_init_c.3            mpich-4.3.0a1/man/man3/MPI_Iallreduce_c.3                mpich-4.3.0a1/man/man3/MPI_Rget_c.3
mpich-4.3.0a1/man/man3/MPI_Alltoall_c.3                  mpich-4.3.0a1/man/man3/MPI_Ialltoall_c.3                 mpich-4.3.0a1/man/man3/MPI_Rput_c.3
mpich-4.3.0a1/man/man3/MPI_Alltoall_init_c.3             mpich-4.3.0a1/man/man3/MPI_Ialltoallv_c.3                mpich-4.3.0a1/man/man3/MPI_Rsend_c.3
mpich-4.3.0a1/man/man3/MPI_Alltoallv_c.3                 mpich-4.3.0a1/man/man3/MPI_Ialltoallw_c.3                mpich-4.3.0a1/man/man3/MPI_Rsend_init_c.3
mpich-4.3.0a1/man/man3/MPI_Alltoallv_init_c.3            mpich-4.3.0a1/man/man3/MPI_Ibcast_c.3                    mpich-4.3.0a1/man/man3/MPI_Scan_c.3
mpich-4.3.0a1/man/man3/MPI_Alltoallw_c.3                 mpich-4.3.0a1/man/man3/MPI_Ibsend_c.3                    mpich-4.3.0a1/man/man3/MPI_Scan_init_c.3
mpich-4.3.0a1/man/man3/MPI_Alltoallw_init_c.3            mpich-4.3.0a1/man/man3/MPI_Iexscan_c.3                   mpich-4.3.0a1/man/man3/MPI_Scatter_c.3
mpich-4.3.0a1/man/man3/MPI_Bcast_c.3                     mpich-4.3.0a1/man/man3/MPI_Igather_c.3                   mpich-4.3.0a1/man/man3/MPI_Scatter_init_c.3
mpich-4.3.0a1/man/man3/MPI_Bcast_init_c.3                mpich-4.3.0a1/man/man3/MPI_Igatherv_c.3                  mpich-4.3.0a1/man/man3/MPI_Scatterv_c.3
mpich-4.3.0a1/man/man3/MPI_Bsend_c.3                     mpich-4.3.0a1/man/man3/MPI_Imrecv_c.3                    mpich-4.3.0a1/man/man3/MPI_Scatterv_init_c.3
mpich-4.3.0a1/man/man3/MPI_Bsend_init_c.3                mpich-4.3.0a1/man/man3/MPI_Ineighbor_allgather_c.3       mpich-4.3.0a1/man/man3/MPI_Send_c.3
mpich-4.3.0a1/man/man3/MPI_Buffer_attach_c.3             mpich-4.3.0a1/man/man3/MPI_Ineighbor_allgatherv_c.3      mpich-4.3.0a1/man/man3/MPI_Send_init_c.3
mpich-4.3.0a1/man/man3/MPI_Buffer_detach_c.3             mpich-4.3.0a1/man/man3/MPI_Ineighbor_alltoall_c.3        mpich-4.3.0a1/man/man3/MPI_Sendrecv_c.3
mpich-4.3.0a1/man/man3/MPI_Comm_attach_buffer_c.3        mpich-4.3.0a1/man/man3/MPI_Ineighbor_alltoallv_c.3       mpich-4.3.0a1/man/man3/MPI_Sendrecv_replace_c.3
mpich-4.3.0a1/man/man3/MPI_Comm_detach_buffer_c.3        mpich-4.3.0a1/man/man3/MPI_Ineighbor_alltoallw_c.3       mpich-4.3.0a1/man/man3/MPI_Session_attach_buffer_c.3
mpich-4.3.0a1/man/man3/MPI_Exscan_c.3                    mpich-4.3.0a1/man/man3/MPI_Irecv_c.3                     mpich-4.3.0a1/man/man3/MPI_Session_detach_buffer_c.3
mpich-4.3.0a1/man/man3/MPI_Exscan_init_c.3               mpich-4.3.0a1/man/man3/MPI_Ireduce_c.3                   mpich-4.3.0a1/man/man3/MPI_Ssend_c.3
mpich-4.3.0a1/man/man3/MPI_File_get_type_extent_c.3      mpich-4.3.0a1/man/man3/MPI_Ireduce_scatter_block_c.3     mpich-4.3.0a1/man/man3/MPI_Ssend_init_c.3
mpich-4.3.0a1/man/man3/MPI_File_iread_all_c.3            mpich-4.3.0a1/man/man3/MPI_Ireduce_scatter_c.3           mpich-4.3.0a1/man/man3/MPI_Status_set_elements_c.3
mpich-4.3.0a1/man/man3/MPI_File_iread_at_all_c.3         mpich-4.3.0a1/man/man3/MPI_Irsend_c.3                    mpich-4.3.0a1/man/man3/MPI_Type_contiguous_c.3
mpich-4.3.0a1/man/man3/MPI_File_iread_at_c.3             mpich-4.3.0a1/man/man3/MPI_Iscan_c.3                     mpich-4.3.0a1/man/man3/MPI_Type_create_darray_c.3
mpich-4.3.0a1/man/man3/MPI_File_iread_c.3                mpich-4.3.0a1/man/man3/MPI_Iscatter_c.3                  mpich-4.3.0a1/man/man3/MPI_Type_create_hindexed_block_c.3
mpich-4.3.0a1/man/man3/MPI_File_iread_shared_c.3         mpich-4.3.0a1/man/man3/MPI_Iscatterv_c.3                 mpich-4.3.0a1/man/man3/MPI_Type_create_hindexed_c.3
mpich-4.3.0a1/man/man3/MPI_File_iwrite_all_c.3           mpich-4.3.0a1/man/man3/MPI_Isend_c.3                     mpich-4.3.0a1/man/man3/MPI_Type_create_hvector_c.3
mpich-4.3.0a1/man/man3/MPI_File_iwrite_at_all_c.3        mpich-4.3.0a1/man/man3/MPI_Isendrecv_c.3                 mpich-4.3.0a1/man/man3/MPI_Type_create_indexed_block_c.3
mpich-4.3.0a1/man/man3/MPI_File_iwrite_at_c.3            mpich-4.3.0a1/man/man3/MPI_Isendrecv_replace_c.3         mpich-4.3.0a1/man/man3/MPI_Type_create_resized_c.3
mpich-4.3.0a1/man/man3/MPI_File_iwrite_c.3               mpich-4.3.0a1/man/man3/MPI_Issend_c.3                    mpich-4.3.0a1/man/man3/MPI_Type_create_struct_c.3
mpich-4.3.0a1/man/man3/MPI_File_iwrite_shared_c.3        mpich-4.3.0a1/man/man3/MPI_Mrecv_c.3                     mpich-4.3.0a1/man/man3/MPI_Type_create_subarray_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_all_begin_c.3       mpich-4.3.0a1/man/man3/MPI_Neighbor_allgather_c.3        mpich-4.3.0a1/man/man3/MPI_Type_get_contents_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_all_c.3             mpich-4.3.0a1/man/man3/MPI_Neighbor_allgather_init_c.3   mpich-4.3.0a1/man/man3/MPI_Type_get_envelope_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_at_all_begin_c.3    mpich-4.3.0a1/man/man3/MPI_Neighbor_allgatherv_c.3       mpich-4.3.0a1/man/man3/MPI_Type_get_extent_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_at_all_c.3          mpich-4.3.0a1/man/man3/MPI_Neighbor_allgatherv_init_c.3  mpich-4.3.0a1/man/man3/MPI_Type_get_true_extent_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_at_c.3              mpich-4.3.0a1/man/man3/MPI_Neighbor_alltoall_c.3         mpich-4.3.0a1/man/man3/MPI_Type_indexed_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_c.3                 mpich-4.3.0a1/man/man3/MPI_Neighbor_alltoall_init_c.3    mpich-4.3.0a1/man/man3/MPI_Type_size_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_ordered_begin_c.3   mpich-4.3.0a1/man/man3/MPI_Neighbor_alltoallv_c.3        mpich-4.3.0a1/man/man3/MPI_Type_vector_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_ordered_c.3         mpich-4.3.0a1/man/man3/MPI_Neighbor_alltoallv_init_c.3   mpich-4.3.0a1/man/man3/MPI_Unpack_c.3
mpich-4.3.0a1/man/man3/MPI_File_read_shared_c.3          mpich-4.3.0a1/man/man3/MPI_Neighbor_alltoallw_c.3        mpich-4.3.0a1/man/man3/MPI_Unpack_external_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_all_begin_c.3      mpich-4.3.0a1/man/man3/MPI_Neighbor_alltoallw_init_c.3   mpich-4.3.0a1/man/man3/MPI_Win_allocate_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_all_c.3            mpich-4.3.0a1/man/man3/MPI_Op_create_c.3                 mpich-4.3.0a1/man/man3/MPI_Win_allocate_shared_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_at_all_begin_c.3   mpich-4.3.0a1/man/man3/MPI_Pack_c.3                      mpich-4.3.0a1/man/man3/MPI_Win_create_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_at_all_c.3         mpich-4.3.0a1/man/man3/MPI_Pack_external_c.3             mpich-4.3.0a1/man/man3/MPI_Win_shared_query_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_at_c.3             mpich-4.3.0a1/man/man3/MPI_Pack_external_size_c.3        mpich-4.3.0a1/man/man3/MPIX_Allreduce_enqueue_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_c.3                mpich-4.3.0a1/man/man3/MPI_Pack_size_c.3                 mpich-4.3.0a1/man/man3/MPIX_Irecv_enqueue_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_ordered_begin_c.3  mpich-4.3.0a1/man/man3/MPI_Put_c.3                       mpich-4.3.0a1/man/man3/MPIX_Isend_enqueue_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_ordered_c.3        mpich-4.3.0a1/man/man3/MPI_Raccumulate_c.3               mpich-4.3.0a1/man/man3/MPIX_Recv_enqueue_c.3
mpich-4.3.0a1/man/man3/MPI_File_write_shared_c.3         mpich-4.3.0a1/man/man3/MPI_Recv_c.3                      mpich-4.3.0a1/man/man3/MPIX_Send_enqueue_c.3
mpich-4.3.0a1/man/man3/MPI_Gather_c.3                    mpich-4.3.0a1/man/man3/MPI_Recv_init_c.3                 mpich-4.3.0a1/man/man3/MPIX_Stream_irecv_c.3
mpich-4.3.0a1/man/man3/MPI_Gather_init_c.3               mpich-4.3.0a1/man/man3/MPI_Reduce_c.3                    mpich-4.3.0a1/man/man3/MPIX_Stream_isend_c.3
mpich-4.3.0a1/man/man3/MPI_Gatherv_c.3                   mpich-4.3.0a1/man/man3/MPI_Reduce_init_c.3               mpich-4.3.0a1/man/man3/MPIX_Stream_recv_c.3
mpich-4.3.0a1/man/man3/MPI_Gatherv_init_c.3              mpich-4.3.0a1/man/man3/MPI_Reduce_local_c.3              mpich-4.3.0a1/man/man3/MPIX_Stream_send_c.3

@hzhou hzhou requested a review from raffenet August 21, 2024 20:28
We list the large count routines in the same man page of their normal
count routines, but the entries are missing. This commit creates the
alias man pages for them.
@hzhou hzhou merged commit d085c60 into pmodels:main Aug 26, 2024
4 checks passed
@hzhou hzhou deleted the 2408_man_c branch August 26, 2024 16:57
@raffenet raffenet added this to the mpich-4.2.3 milestone Aug 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

man MPI_Type_vector_c is not available
2 participants