apricote/hcloud-upload-image
1
0
Fork 0
mirror of https://github.com/apricote/hcloud-upload-image.git synced 2026-01-13 21:31:03 +00:00
Code Issues Projects Releases Packages Wiki Activity

cmd/upload: document "raw" default for --format argument

Browse source 
When first using the tool, based on the `--help` output I did not
realize that `raw` was a supported format. Then, upon stumbling on a
GitHub issue that documents this format as being able to stream larger
images directly to disk, I found out that specifying `--format raw`
does not work, and leads to a failure relatively late in the image
upload process.

This documents that, when not specifying `--format`, a default format
of `raw` is assumed.
This commit is contained in:
Leon Schuermann 2025-11-03 09:29:28 -05:00
parent 921d688fd4
commit 8a159d34a6
2 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

2
cmd/upload.go
View file

@ -127,7 +127,7 @@ func init() {
cobra.FixedCompletions([]string{string(hcloudimages.CompressionBZ2), string(hcloudimages.CompressionXZ)}, cobra.ShellCompDirectiveNoFileComp),
)
uploadCmd.Flags().String(uploadFlagFormat, "", "Format of the image. [choices: qcow2]")
uploadCmd.Flags().String(uploadFlagFormat, "", "Format of the image. [default: raw, choices: qcow2]")
_ = uploadCmd.RegisterFlagCompletionFunc(
uploadFlagFormat,
cobra.FixedCompletions([]string{string(hcloudimages.FormatQCOW2)}, cobra.ShellCompDirectiveNoFileComp),