doc/wiki: Added generated CVAR descriptions. - #7902
Open
KLeoUIC wants to merge 1 commit into
Open
Conversation
Currently in alphabetical order, generating script and instructions in Box
hzhou
reviewed
Jul 24, 2026
| @@ -0,0 +1,4420 @@ | |||
| **MPIR_CVAR_ABORT_ON_LEAKED_HANDLES** - MEMORY | |||
Collaborator
There was a problem hiding this comment.
Add a title to the document, e.g. # MPICH Control Variables
| * false - default, report leaked handles without aborting. | ||
| * true - abort when leaked handles are detected during finalization. | ||
|
|
||
| Used in functions: MPIR_check_handles_on_finalize |
Collaborator
There was a problem hiding this comment.
Quote the function names.
Used in functions: MPIR_check_handles_on_finalize
| @@ -0,0 +1,4420 @@ | |||
| **MPIR_CVAR_ABORT_ON_LEAKED_HANDLES** - MEMORY | |||
Collaborator
There was a problem hiding this comment.
How about just use a header style:
### MPIR_CVAR_ABORT_ON_LEAKED_HANDLES
And remove the category. I think it is not a useful information.
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Provides website formatted descriptions of CVARs for the wiki.
Gives users who want to tinker and tune MPI a unified place for information. MPI_T_cvar_get_info works in code for runtime added CVARs but is terminal only, this provides a more stable second monitor lookup.
Currently in alphabetical order, generating script and instructions in Box
Pull Request Description
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.