containertool: Correct help text for --username and --password #123
Conversation
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
Motivation ---------- The help text for `--username` and `--password` states that these options override `.netrc`. In fact they are used as defaults if no suitable entry is found in `.netrc`. Modifications ------------- Correct the option descriptions in the manual page. Result ------ Documentation accurately describes what the options do. Test Plan --------- All existing tests continue to pass. No functional change.
euanh
added
area/documentation
euanh
added a commit
that referenced
this pull request
May 1, 2025
…ord (#125) Motivation ---------- The `--username` and `--password` options define default values which are used if no suitable credentials can be found in `.netrc`. Their current names could imply that they override other sources of credentials - the help originally said this was the case (#123). Renaming them to `--default-username` and `--default-password` reduces the risk of misunderstanding. Modifications ------------- * Rename the `--user` and `--password` options to `--default-user` and `--default-password`. * Add checks to warn that the old versions are deprecated, and fail if both are provided together. * Hide the old options from `--help` and remove them from the manual page * Rename the environment variable versions of these options. The environment variable change had not yet been released so deprecation warnings are not needed. Result ------ * New users will see more descriptive option names * Existing users will be prompted to change the options they pass Test Plan --------- All existing test continue to pass.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Motivation
The help text for
--usernameand--passwordstates that these options override.netrc. In fact they are used as defaults if no suitable entry is found in.netrc.This pull request cherry picks the help text changes from #119, without introducing the new environment variables.
Modifications
Correct the option descriptions in the manual page.
Result
Documentation accurately describes what the options do.
Test Plan
All existing tests continue to pass. No functional change.