Skip to content

doc/wiki: Added generated CVAR descriptions. - #7902

Merged
hzhou merged 4 commits into
pmodels:mainfrom
KLeoUIC:0724_cvar
Sep 30, 2026
Merged

hzhou merged 4 commits into
pmodels:mainfrom
KLeoUIC:0724_cvar

Conversation

@KLeoUIC

@KLeoUIC KLeoUIC commented Jul 24, 2026 •

Copy link
Copy Markdown
Collaborator

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

  • 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.

Comment thread doc/wiki/cvar.md Outdated
Comment thread doc/wiki/cvar.md Outdated
Comment thread doc/wiki/cvar.md Outdated
KLeoUIC and others added 2 commits September 30, 2026 14:48
Currently in alphabetical order, generating script and instructions in Box
Add title, use h3 headers for CVAR names, backtick-quote function
names, and organize entries into sections with a table of contents.
Remove 8 stale entries not found in source. Add 16 missing CVARs
with descriptions derived from source YAML declarations and code
usage. Rebuild sections to restore correct groupings.
@hzhou
hzhou merged commit 79f24b3 into pmodels:main Sep 30, 2026
6 checks passed
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.

2 participants