Improve storage volume help #973
Merged
+3,957
−3,298
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
stgraber
reviewed
Jul 8, 2024
cmd/incus/storage_volume.go
Outdated
Comment on lines
958
to
959
| cmd.Example = cli.FormatSection("", i18n.G( | ||
| `incus storage volume edit [<remote>:]<pool> [<type>/]<volume> < volume.yaml |
There was a problem hiding this comment.
Examples should be functional, so not include variables or optional entries.
So in this case we'd probably have to change it to something like:
incus storage volume edit default foo < volume.yaml
Update the foo custom storage volume in the default pool with YAML data from volume.yaml
|
I'm taking a look at this one as there are a few more edits that are needed here I think. |
This makes a few changes: - Consistently say "custom storage volume" for anything that only applies to custom volumes - Have all relevant help messages mention that custom is the default type and list other possible types - Make all examples more consistent - Fix a number of incorrect comments Signed-off-by: AJRepo <[email protected]> Signed-off-by: Stéphane Graber <[email protected]>
Signed-off-by: AJRepo <[email protected]>
Signed-off-by: Stéphane Graber <[email protected]>
stgraber
force-pushed
the
incus_volume_help
branch
from
877cf4f
to
569674d
Compare
stgraber
approved these changes
Jul 8, 2024
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.
As someone who was new to incus, I had some confusion about "type" as it related to volumes. This help text update hopefully helps others who are new to incus not have that same confusion.
This update does the following:
Moved description text from "cmd.Example" section to cmd.Long section. Now the example sections only have examples.
Added additional example to --help for "incus storage volume" command to show virtual-machine example
added Error text for when the default (custom) is used and reports "not found". Note: this introduces an
ifstatement which gives different error messages depending on if someone usescustomor not. If that is not ok, feel free to remove.Ran
make i18n(separate commit)