doc: fix mansrc generation #7107
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Just using the name without prefix, e.g. MPI_Send -> send.txt, resulting in duplicated filenames between MPI_/MPI_T_/MPIX_ functions, and they overwrite each other. This resulted in certain man pages missing. For example, MPI_Finalize and MPI_Init_thread man pages were missing because they were overwritten by the MPI_T_ correspondents.
|
I locally verified the man pages for |
raffenet
approved these changes
Aug 20, 2024
|
Somehow the CI triggers are stuck. I'm going to merge anyway since the fix is trivial and won't be covered by the CI anyway. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Description
Just using the name without prefix, e.g. MPI_Send -> send.txt, resulting in duplicated filenames between MPI_/MPI_T_/MPIX_ functions, and they overwrite each other. This resulted in certain man pages missing. For example, MPI_Finalize and MPI_Init_thread man pages were missing because they were overwritten by the MPI_T_ correspondents.
The fix is to use the whole name for mansrc files, e.g.
MPI_Finalize.txtandMPI_T_Finalize.txt.Fixes #7089
[skip warnings]
Author Checklist
Particularly focus on why, not what. Reference background, issues, test failures, xfail entries, etc.
Commits are self-contained and do not do two things at once.
Commit message is of the form:
module: short descriptionCommit message explains what's in the commit.
Whitespace checker. Warnings test. Additional tests via comments.
For non-Argonne authors, check contribution agreement.
If necessary, request an explicit comment from your companies PR approval manager.