Skip to content

show_help: only parse specific trees for help files #13247

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

Merged

Conversation

jsquyres
Copy link
Member

@jsquyres jsquyres commented May 10, 2025

Change --root CLI param to --roots in order to accept a specific list of root directories to traverse to look for help files (rather than a single top-level root that contains all the directories that we want to traverse -- but which also contains directories that we don't want to traverse). Also, just for the heckuvit, parameterize the list of subdirectories to skip (via --skip-dirs).

Using --roots prevents us from accidentally traversing into VPATH build directories, for example, and finding PMIx and/or PRTE help files.

@rhc54
Copy link
Contributor

rhc54 commented May 10, 2025

Thanks - I already do that since the beginning as it was just easier on my code (only one root directory).

Change --root CLI param to --roots in order to accept a specific list
of root directories to traverse to look for help files (rather than a
single top-level root that contains all the directories that we want
to traverse -- but which also contains directories that we *don't*
want to traverse).  Also, just for the heckuvit, parameterize the list
of subdirectories to skip (via --skip-dirs).

Using --roots prevents us from accidentally traversing into VPATH
build directories, for example, and finding PMIx and/or PRTE help
files.

Signed-off-by: Jeff Squyres <jeff@squyres.com>
@jsquyres jsquyres force-pushed the pr/limit-show-help-generation-scanning branch from 4a3867d to 114cd4d Compare May 12, 2025 14:50
@jsquyres jsquyres merged commit 9b06b34 into open-mpi:main May 12, 2025
18 checks passed
@jsquyres jsquyres deleted the pr/limit-show-help-generation-scanning branch May 12, 2025 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants