-
Notifications
You must be signed in to change notification settings - Fork 37
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
Show invocable's help even without a config file #639
Merged
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
makubacki
reviewed
Aug 30, 2023
makubacki
approved these changes
Aug 30, 2023
Enables the invocable to display it's command line arguments if `-h` or `--help` is provided, regardless of if it has a configuration file.
Co-authored-by: Michael Kubacki <michael.kubacki@microsoft.com>
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #639 +/- ##
==========================================
- Coverage 78.83% 78.74% -0.10%
==========================================
Files 49 49
Lines 4843 4850 +7
==========================================
+ Hits 3818 3819 +1
- Misses 1025 1031 +6
|
Javagedes
added a commit
to Javagedes/edk2-pytool-extensions
that referenced
this pull request
Dec 18, 2023
Changes made in tianocore#639 to ensure the invocable displayed their command line arguments when a build module was not provided failed to test the critical scenario of ensuring the help message was still displayed when a build module was provided. The help command line argument is consumed during the first pass of the command line argument parser, so when the build module is found, registered, and the parser is re-executed, the help argument is no longer present to trigger the help message display. This commit fixes the issue by adding the "--help" command line argument to the arguments to be parsed if it was detected in the first parse.
Javagedes
added a commit
to Javagedes/edk2-pytool-extensions
that referenced
this pull request
Dec 18, 2023
Changes made in tianocore#639 to ensure the invocable displayed their command line arguments when a build module was not provided failed to test the critical scenario of ensuring the help message was still displayed when a build module was provided. The help command line argument is consumed during the first pass of the command line argument parser, so when the build module is found, registered, and the parser is re-executed, the help argument is no longer present to trigger the help message display. This commit fixes the issue by adding the "--help" command line argument to the arguments to be parsed if it was detected in the first parse.
Javagedes
added a commit
that referenced
this pull request
Dec 18, 2023
Changes made in #639 to ensure the invocable displayed their command line arguments when a build module was not provided failed to test the critical scenario of ensuring the help message was still displayed when a build module was provided. The help command line argument is consumed during the first pass of the command line argument parser, so when the build module is found, registered, and the parser is re-executed, the help argument is no longer present to trigger the help message display. This commit fixes the issue by adding the "--help" command line argument to the arguments to be parsed if it was detected in the first parse.
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.
Enables the invocable to display it's command line arguments if
-h
or--help
is provided, regardless of if it has a configuration file.Examples
stuart_build
WARNING: Some command line arguments may be missing. Provide a platform module file to ensure all command line arguments are present. usage: stuart_build [-h] [-c PLATFORM_MODULE] options: -h, --help show this help message and exit -c PLATFORM_MODULE, --platform_module PLATFORM_MODULE Provide the Platform Module relative to the current working directory.This should contain a BuildSettingsManager instance.
stuart_ci_build