main,README: improve docs around --progress
#776
Merged
+38
−26
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
achilleas-k
requested changes
Jan 6, 2025
achilleas-k
previously approved these changes
Jan 6, 2025
This commit adds the two most useful progress types (as of today) to the help string of `--progress`: plain and term. This should make the usage a bit more discoverable.
This commit adds the missing documentation for `--progress` in the README. Not having this lead to some confusion, e.g. in questions in osbuild#765 that a better README would have avoided. Hopefully this answers the questions :)
Previously an empty string in `--progress` meant to "auto-select". But that is not super intuitive so this commit makes it explicit using "auto". Thanks to Achilleas for the suggestion.
This commit renames the "plain" progress to "verbose" progress. The new name is closer to what the intention of the this progress is and easier for the users to understand. Thanks to Ondrej for the suggestion.
|
Sorry, had to force push to fix a test failure, please re-review. |
github-merge-queue
bot
removed this pull request from the merge queue due to no response for status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
mvo5
added a commit
to mvo5/bootc-image-builder
that referenced
this pull request
Jan 9, 2025
This commit adds `--verbose,-v` which will increase the verbosity of logrus and also switch the --progress to "verbose". This is addressing the feedback we got in osbuild#765 and a followup for osbuild#776 The new `-v` clashes unfortunately with cobras default for version, so there is no single dash flag for version anymore. Most unix tools (e.g. cp,rsync,mv,curl,ssh,tar) use "-v" for "--verbose" so IMHO we should follow suite. Unfortuantely there is no consistency in linux, e.g. git,gcc are counter examples where it means version). I would still go with -v for verbose as ssh,tar,curl are probably used more often to get verbose output.
mvo5
added a commit
to mvo5/bootc-image-builder
that referenced
this pull request
Jan 9, 2025
This commit adds `--verbose,-v` which will increase the verbosity of logrus and also switch the --progress to "verbose". This is addressing the feedback we got in osbuild#765 and a followup for osbuild#776 The new `-v` clashes unfortunately with cobras default for version, so there is no single dash flag for version anymore. Most unix tools (e.g. cp,rsync,mv,curl,ssh,tar) use "-v" for "--verbose" so IMHO we should follow suite. Unfortuantely there is no consistency in linux, e.g. git,gcc are counter examples where it means version). I would still go with -v for verbose as ssh,tar,curl are probably used more often to get verbose output.
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.
This PR adds some missing documentation around the new
--progressswitch. This hopefully helps with the questions/uncertainty raised in e.g. #765